よいマニュアルを作る8つのポイント(前半)

032_yoi_maunal1

良いマニュアルを作るには、おさえておくべきポイントがいくつかあります。逆に言うと、このポイントさえおさえておけば良いマニュアルができるという寸法です。わたしたちがこれまでつちかってきた経験から、これぞという秘訣をまとめてみました。前・後半にわけてお送りします。

1. マニュアルの読者をイメージする

過去のエントリーでも述べさせていただきました、読者の問題。言うまでもないことですが、マニュアルにはかならず読者の存在がついてまわります。作成するマニュアルをだれが読むのかによって、もりこむ内容が変わってくるものなのです。具体的には、

  • 初心者:難解な用語を使ってもわからない。一から十まで説明してあげないといけない。
  • 中堅:専門用語を使っても理解できる。おおまかな説明でも前後の流れがほぼ理解できる。

など、読者のレベルによって内容・分量がおおきく変化します。あらためて強調させていただきますが、物事を「伝える」にはかならず相手が必要です。それでもうっかり忘れがちなのが「読者の視点」なのです。相手のことを考えたマニュアルを作りましょう。

2. スタートとゴールを決めておく

どこから作業を始めて、どこまでやったら作業完了か、しっかり決めておきましょう。たとえば、機械の使いかたを知っているのか否か、知らないならその使用方法もマニュアルに書かないといけない  作業開始がどこかを決めておかないと、マニュアルもスタートを切ることができません。かといって、不要な情報を盛り込んでしまったら、せっかく作成したページが無駄になってしまいます。

同時に、どこまでやったら作業完了なのか、きちんとゴールを示します。そうしないと「これで終わりでいいの?」と読者に不安を与えることになります。

3. 作業工程を考える

マニュアルを書きはじめるまえに、全体の手順を決めることが重要です。スタートとゴールが決まったらそのあいだの過程についても決めておく、ということですね。手順の羅列でけっこうですので、まずは書き出してみましょう。つぎに、全体をイメージできたら順番に並び替えてみましょう。並び替えたときに、抜けている手順はないでしょうか。それを補っていけば、マニュアルに記載する手順が固まります。

手順が形になったら、こんどは章立てを考えてみます。スタートとゴールでは作業工程がまったく異なるものであっても、中間工程は連続した過程を経ています。ひとつづきの作業工程を一つのブロックとしてくくってしまい、手順のまとまりを分割します。このまとまりが「章」にあたります。手順を章に細分化することで、全体を俯瞰した時の検索性・一覧性が格段に向上します。

4. 文字入力について

別のエントリーでも書いたように、使用する文章はとにかく「わかりやすさ」第一です。具体的には、一文につき一動作をあらわすよう、意識してみましょう。極端に言うと、対象物とその動きだけでも構いません(「○○を□□します」というように)。

文章が長すぎると、何をどうするのか、すべきことについての印象が薄くなってしまいます。あれもやって、これもやって…だと作業者も混乱してしまいます。あくまでも簡潔に、平易な言葉づかいをこころがけてみましょう。

後半へつづく

前半部分、いかがでしたでしょうか。「なーんだ、そんな簡単なことだったんだ」と思っていただけばしめたもの。後半をお楽しみに!