一度読めばわかるマニュアルの書き方

お客様がサポートに問い合わせてくる、新しい社員が同じ質問を繰り返す、「マニュアルどおりに」やったはずの作業がうまくいかない。たいていの場合、原因はマニュアルそのものにあります。作業を知り尽くしているために、初めての人がどこでつまずくのかが見えない人が書いているのです。ユーザーガイドでも、ヘルプセンターの記事でも、業務手順書でも、一度で伝わるマニュアルにするための7つのルールを紹介します。

1. 1つのマニュアルに1つの作業

「アカウントの設定方法」では範囲が広すぎます。「パスワードの変更方法」と「チームメンバーの追加方法」は、別々のマニュアルです。読者は1つの作業を探し、見つけ、実行して、去っていきます。

2. 最初に結果と必要なものを書く

最初の2行で、読者が何を達成できるのか、そして始める前に何が必要か（アクセス権限、ファイル、パスワード、10分の時間など）を伝えます。ステップ7で初めから必要なものがあったと気づくほど、もどかしいことはありません。

3. 番号付きの手順、1ステップに1つの操作

各ステップは1つの操作にし、動詞で示します。「設定を開きます」「保存をクリックします」。ステップに「〜してから」が入っていたら、それは2つのステップです。番号があれば読者はどこまで進んだかを見失わず、サポートも「ステップ4をご覧ください」と案内できます。

4. 自分の言葉ではなく、読者の言葉で

ボタンやメニューの名前は、読者が画面で目にするとおりに書きます。社内用語や略語は避け、どうしても必要な用語は最初に出てきたときに説明します。

5. どうなるはずかを示す

重要なステップの後には、その結果を書きます。「緑色のメッセージ『保存しました』が表示されます」。読者は正しく進んでいると確認でき、何かがおかしいときもすぐに気づけます。

6. 注意書きはステップの後ではなく前に

「削除をクリックする前に、データをエクスポートしてください。削除したデータは復元できません。」ステップの後に置かれた注意書きでは、手遅れです。

7. 初めての人でテストする

その作業をしたことのない人にマニュアルを渡し、手を貸さずに見守ります。迷った箇所、質問した箇所、間違えた箇所は、すべて書き直すべき箇所です。5分のテストで、1時間読み返すよりも多くの問題が見つかります。

画像と構成

• 画面上の操作には、押すべきボタンに印を付けたスクリーンショットを。インターフェースが変わったら更新します。
• 長い手順には見出しを付け、読者が必要な部分にすぐ移動できるようにします。
• 最後によくあるトラブルをまとめた**「困ったときは」のセクション**を。「メールが届かない場合は、迷惑メールフォルダを確認してください」など。

まとめ

1つの作業、最初に結果と必要なもの、1操作ずつの番号付き手順、読者の言葉、期待される結果、早めの注意書き、そして実際の人によるテスト。ガイド、ヘルプ記事一式、業務手順書の作成が必要なら、ユーザーガイド・業務マニュアルを注文できます。製品やプロセスを説明すれば、わかりやすく構造化されたマニュアルが届きます。お支払いは納品を承認した後にはじめて確定します。