こんにちは、Webディレクターの矢郷です。
今回のテーマはマニュアル作成。
社内の業務効率化用、またはお客様への提出用…。
Web制作において必要不可欠なマニュアル作成ですが、作成するならなるべくわかりやすいマニュアルを作成したい!ということで作成手順とともにコツをまとめました。

目次

    1.目的を考える

    まずはマニュアルの目的を決定します。
    今回は「レシピ本」を例として考えましょう。
    レシピ本を見たとき、全てのジャンルで全ての料理が書かれているわけではありません。
    何のジャンルで何の料理についてなのか、分かれているレシピ本が多いと思います。
    例えば「初心者でも簡単に作れる(ジャンル)クッキー集(料理)」といった具合ですね。
    これが「目的」です。
    まずは何の業務や作業についてなのか、何のために必要なマニュアルなのか考えてみましょう。

    2.必要な業務と作業工程を洗い出す

    目的が決まったら、マニュアルの大項目となる業務を洗い出します。
    とはいっても何を洗い出せばいいの?と思うかもしれません。
    ここでもまた「レシピ本」を例として考えてみましょう。
    「クッキー集」を仮に作成しようと考えた場合、まずはクッキーの種類を考えます。
    「サブレ」「ビスキュイ」「ラングドシャ」など、思いつく限り例を出します。これが「業務」となります。
    次に作業工程を考えます。
    クッキー集の例では大項目の「クッキーの種類」を元に、各クッキーの「作り方」を考えていきます。これが「作業工程」です。

    マニュアルの目的にいたるまでの大項目を考えられるだけ洗い出し、その大項目にいたるまでの作業工程を考えていきましょう。
    「〇〇したいとき、何をしたらできるか」という作業者目線になることが重要です。

    3.手順書に落とし込む時のコツ

    では実際に洗い出した項目を手順書に落とし込んでいきましょう。
    誰にでもわかるような手順書を作成するコツはたったの4つ!

    • 用語の表記は統一させる
    • 説明文は端的に短く、図を使用する
    • 専門的用語を使うときは注釈を入れる
    • 実際に作業をしながら確認を行う

    ■用語の表記は統一させる

    誤解が生まれないように用語の表記は統一させましょう。
    例えばページによって「このゲームはWindows 10限定です」や「このゲームはWin限定です」という表記のばらつきがあるとどちらが正しいのか曖昧になってしまいます。
    表記を統一させるために、用語は略称を使わず正式名称で記載することがポイントです。

    ■説明文は端的に短く、図を使用する

    人間が持つ集中力は8秒まで、という話があります。
    つまりそれ以上の時間がかかると、頭に入ってきづらいということです。
    説明文が長いものと、端的な説明文で図が多いものはどちらが分かりやすいでしょうか。

    例1)説明文が長い

    説明文:
    テストサイトを開いてIDは△△、パスは〇〇を入力してログインボタンをクリックして表示されたページの、右側にある「次へ」というボタンをクリックして、表示されたページの下部の「アンケート送信」を押して登録完了です。

     

    例2)端的な説明文で図が多い

    説明文:
    1. テストサイトを開き、下記を入力してログインボタンをクリックする。
    ID:△△
    パス:〇〇

     

    2.「次へ」ボタンをクリックする。

     

    3.「アンケート送信」ボタンをクリックして完了。

     

    説明文がながい例1より端的な説明文で図が多い例2の方が、どのようなページに遷移してどこをクリックすればいいのか視覚的にわかりやすく、またイメージがつきやすいですね。
    つまり、読み手に理解する時間を長く与えないことがポイントです。

    ■専門的用語を使うときは注釈を入れる

    マニュアルは、誰が読んでも同じ解釈ができるよう専門用語を使わない、あるいは使っても注釈を入れましょう。
    「誰が読んでも同じ作業結果が得られること」がマニュアルの基本なので、曖昧な表現なども避ける必要があります。
    例えば、りんご飴の作り方で「りんごに串を刺してから飴を付ける場合もある」という説明文は「りんごに串を刺してから飴を付ける場合もあるし、つけない場合もある」というような解釈の違いが出てしまいます。
    こういった曖昧な表現は避け、「りんごに串を刺してから飴を付ける」と一通りの書き方にすることがポイントです。

    ■実際に作業をしながら確認を行う

    一通りマニュアルの作成が終わったら、実際にこの手順で作業を行うことができるのか、同じ作業結果になるのか確認を行います。
    自分だけではなく、作業手順を知らない第三者に確認してもらうこともとても重要です。
    自分ではわからない作業手順の抜け漏れや不明点、知らずに使ってしまっていた専門用語など、第三者が見ることで改めて発見できることがあります。
    そうして発見された疑問点や抜け漏れは、必ずマニュアルへ落とし込むようにしましょう。

    4.完成が終わりではない!

    確認もきっちり行い作業手順も問題なくマニュアルの作成完了!といきたいところですが、マニュアル作成は完成したら終わりではありません。
    日々、何かしらの理由によって作業工程のアップデートは行われていくものです。
    「こういう手順で今まで行ってきたけど、ここを変えたら作業効率が上がるのではないか」、「昔から同じ機械を使って作業を行ってきたけど、機械が新しくなったことによって手順が変わった」など。
    その都度マニュアルの更新を行って運用をしていくことが、マニュアル作成の終わりで「始まり」とも言えるでしょう。

    いつもよりも少しだけ人のことを思って作成することが、わかりやすいマニュアル作成への第一歩です。

    矢郷 Webディレクター

    2018年入社。2019年11月より、サポートデスクからディレクターに転身。
    スピーディな運用業務を心掛けている。
    よく賞味期限切れのパンを食べている。