クライアント常駐の業務ではマニュアルを作成する機会が非常に多いです。新しいサービスやアプリケーションを導入する際に、管理者向けの運用を考慮したものや業務でサービスを利用する社内ユーザ向けのものあります。作成する際の大まかな手順は、ターゲットの設定→操作内容の精査→マニュアル作成→挙動確認→記述→プレビュー→修正 という流れですが、今回はこの流れの中で私が心掛けている点を挙げてみます。
① ダーゲットユーザのレベルを考慮する
ターゲットユーザのITリテラシーは異なります。初心者から上級者まで幅広いユーザがいるため、マニュアルの内容や表現を選択する際にユーザの知識レベルを考慮する必要があります。ここを間違えると目標を達成できません。
② 専門用語を避ける
私自身も頻繁にそういう体験をしていますが、IT関連の用語は専門的で理解しづらいことがあります。ユーザが理解しやすいように専門用語を避け、簡潔で具体的な表現を使うことが重要です。どうしても専門用語を避けられない場合は注釈を入れることもありますが、それで文章が冗長にならないように注意が必要です。
③ 図やスクリーンショットを活用する
言葉だけでは伝わりにくい場合は、図やスクリーンショットを使用して視覚的に説明することで、ユーザが理解しやすくなります。図や写真に限らず、フォントサイズが大きすぎる・小さすぎるといったことだけでも読みやすさは大きく異なってきます。
④ 手順を順序立てて記載する
ユーザが手順を追いやすいよう、明確な順序で記載することが大切です。手順を飛ばさないようにするために順序を十分に意識します。自分で作成していて違和感がある場合には、「マニュアル構成」手順に立ち返り、全体を俯瞰する必要があります。
⑤ 問い合わせ先を明確にする
ユーザが疑問や問題が生じた際に、どこに問い合わせるべきかを明確に示すことでスムーズにサポートすることができます。管理者の立場でもサービスのサポート窓口への導線が不親切だとそれだけで不安に感じてしまいます。
⑥ 都度修正していく
マニュアルの内容を修正していくことも重要なことです。機能やユーザインターフェースの変更等により、マニュアルの内容と実際の表示がズレていきます。ユーザからのフィードバックや管理者側の作業により発見した修正点は都度マニュアルに反映させていかなければ、いずれマニュアルとしての機能を失ってしまいます。
2024年10月