情報親方の泣く子も”わかる”マニュアル作成の9つのステップ

創業手帳

忙しいスタートアップベンチャーのためのマニュアル作成の基本

manual-document

(2014/9/1加筆修正・更新しました)

日頃の業務に忙しく、なかなか手が回らないマニュアルの作成。起業して間もない創業期のスタートアップでは、時間もノウハウもないところで、「どうしよう」と時間ばかり過ぎて後回しになっていないだろうか?

本文を読む

今回は、業務や製品のマニュアル(説明書)を作るコツについて取り上げよう。


「作ろう」という一歩を踏み出す

マニュアルは完璧なモノでないとダメ」という認識があるかもしれないが、最初から完璧なマニュアルを目指す必要はない。

「計画する」→「作る」→「ブラッシュアップする」と順序よく実行することが大切だ。

マニュアル制作の手順を知る

マニュアルは、以下のような手順で制作する。

マニュアルの制作手順

1.マニュアルの 5W2H を決める
2.情報を収集する
3.情報を整理し、構成を決める
4.どのように表現するかを決める
5.原稿を作成する
6.レイアウトしたデータを作成する
7.チェックやレビューでマニュアルの完成度を上げる
8.マニュアルを公開する
9.問い合わせ内容等を検証し、マニュアルブラッシュアップする


sogyotecho_lp468x60

1.マニュアルの 5W2H を決める

着手の段階で、いつ(When)、どこで(Where)、誰(Who)が、何をする(What)マニュアルか?を(考えるだけでなく)文字にして、なぜ(Why)、どのように(How)、コストをどのくらいかける(How much)のかを決める。

マニュアルの5W2Hを決める
  • マニュアルはユーザー(特に初心者)のものだと認識する。
  • マニュアルに期待する効果(問い合わせコストを少なくする、利用者の認識違いを減らす等)や目標、予算を決める。
  • スケジュールや予算にあわせてどこまで書くかを決める。
  • エンドユーザー(マニュアルの利用者)はどういう人かを明確にし、業務や商品に触れるときの行動を注意深く観察する。


業務マニュアルの制作計画のポイント

マニュアル制作をアウトソースせず、組織内で日々の業務をマニュアル化する場合、まずは日頃業務を行う者がマニュアルの基礎を作ることになる。日常業務を行いながらこつこつとマニュアルを制作することが多くなるが、制作計画の段階で5W2Hを明確にしておかないとずるずると時間ばかりが過ぎていくことになる。

業務マニュアルの制作計画のポイント
  • 無理のない範囲で、仮でも良いので、着手~完成までの日程を決めてしまう。
  • 原稿が完成するまでに、未経験者が実際に「マニュアル通りに」業務を行ってみて、良い点、改善する点をリストアップしてみる。
  • 組織内の未経験者でも無理なく活用できるか、熟練者の「カン」がマニュアルに反映されているか、を検証する。業界用語や専門用語は未経験者でも分かるように書いたほうが良い。


製品マニュアルの制作計画のポイント

製品マニュアルの場合は、製品が世の中に出回ると利用者の特定が難しくなる。製品が正しく使えることはもちろん、迷いのない表現やわかりやすい構成、問い合わせや不具合発生時の対応もできるマニュアルであることが求められる。

製品マニュアルの制作計画のポイント
  • 製品の納期にあわせて、着手~完成までの日程を決めてしまう。
  • 完成するまでに関係者でマニュアルを検証(レビュー)する行程が必要。複数の担当者がいれば担当者ごとに認識が違っていたり、組織の思想とずれている場合、最終的によくわからないマニュアルになってしまうことがある。
  • 用語や言い回しをあらかじめ統一しておき、業界用語や専門用語は極力使わない。
  • 訴訟や問い合わせの対応も製品出荷後のコストになることがあるので、あらかじめ問合せがあると想定していることは、答えを書くようにする。
  • 製品に対してマニュアルは「部品」となるので、コストも大事だが、書くべき事を十分検討して、書き漏れの無いようにしたい。


2.情報収集(ヒアリング)には準備が必要

業務や製品をよく知っている人にヒアリングすることはマニュアルを作成する上でとても重要だ

関係者へのヒアリングの前には、業務や製品の企画書、仕様書やカタログ等があれば、可能な限り入手しておき、事前に質問をまとめておくと良いだろう。

ここでの注意点は、業務や製品をよく知っている人の視点は、初心者ユーザーとは異なることがあるということだ。ヒアリングの前に「もし自分が初心者だったらこう思う」ことをリストアップしておき、よく知っている人に質問してみよう。よく知っている人でも気づかなかった大事なことが出てくることもある。

また、ヒアリングの内容をマニュアルにそのまま書かず、初心者ユーザーに有益かどうか制作者が判断することが必要である。

3.情報整理の方法

まず、集めた情報を、操作の手順や重要度(いつも必要、たまに必要、ほとんど使わない等)で分類する。

目次には、7(±2)項目で共通項目をまとめ、3段階程度の階層に抑える(下図参照)。

manual-document-140901fig01

必要であれば目的別(基礎編/応用編、利用者編/管理者編)等に冊子を分ける

4.どのように表現するかを決める

ユーザーが製品を使用する場面を想定し、共通項目ごとに UI(ユーザーインターフェイス)やレイアウトを揃える。

大見出し、小見出し、本文等は、3倍程度のサイズ差をつける(下図参照)。

manual-document-140901fig02

色使いは、基本的な説明の部分では無意味に派手にせず、目立たせたい場所に限り色を変える。色覚に不自由な方にも判別できるように、カラーユニバーサルデザイン機構(CUDO)等の資料を参考にするのも有効な手段だ。


5.原稿を作成する

決めた構成と表現方法にあわせて「レイアウト原稿」、「イラスト原稿」、「テキスト(文字)原稿」を作成する。

レイアウト原稿は、イラストやテキストを揃えて配置したり、文字の大きさや種類を指定したりする原稿だ。イラスト原稿は、制作に手間がかかるので、出来るだけ早い段階で完成させておいた方がよい。

テキスト原稿を作成する場合は、次のような点に注意だ。

原稿とデータを作成するときのポイント
  • ユーザーの使用状況をイメージする。
  • 主観ではなく客観(ユーザー目線)で書く。
  • 表現は可能な限り統一する。
  • 一文一義で書く。
  • あいまいな文章を書かない。
  • 書いた文章を音読してみる。
  • 専門用語、業界用語、差別用語は使わず、必要な場合は用語解説をつける。
  • 著作物を引用する場合は著作元の指示に従う。
  • わかりにくい事例を説明する場合は、広く認知された例を参考にする。


ユーザー目線で書くポイント

細分化して対策をマニュアルに書くことで、作業の効率が上がる。ポイントはユーザー目線にたって、対策を書くことだ。

たとえば、「コーヒーカップを洗う」作業の場合、ただ単に「洗う」と書くのではなく、ユーザーがコーヒーカップのどこに触れているかを観察することで、「洗いにくい部分」「汚れが落ちにくい部分」がわかる(下図参照)。

manual-document-140901fig03

6.レイアウトしたデータを作成する

紙面のレイアウトが出来るソフトウェアで、テキスト原稿、イラスト原稿をデータ化する(下図)。イラストやテキストの位置、大きさなどを統一したり、必要な部分で差別化すればするほど、読みやすくなる紙面になることが多い。
manual-document-140901fig04
また、ページいっぱいにテキストやイラストを配置するのではなく、適度にホワイトスペースを確保しても読みやすい紙面になる。

作成ツールとして、マニュアル作成用のソフトウェアを利用するのも良いが、簡易的なマニュアルであれば、ワード等の日頃使い慣れたツールで十分作成可能だ。

7.チェックやレビューで完成度を上げる

まず、制作者自身がマニュアルをチェックする。単位、数値は正しいか?他者の権利を侵害していないか?等にも注意を払わなくてはならない。

次に、制作者以外の人がマニュアルのチェックやレビューをする。制作者の目線では気づかなかったことが見つかり、完成度が上がる。レビューは多人数ではなく、3~5 人程度のメンバーで行うと意見がまとまりやすい。初心者の意見に重要なヒントが隠されていることもある。

8.マニュアルを公開する

チェックとレビューを繰り返して完成度が上がったら、マニュアルを公開しよう。

9.ブラッシュアップを怠らない

最後に、完成したマニュアルを運用中に、製品の仕様変更やマニュアルに不具合が見つかったら、マニュアルを改訂するのを忘れないようにしたい。

「古くて使えないマニュアルの数だけが多い」というのは、企業の規模にかかわらず多い。せっかく作ったマニュアルを生かすためにもマニュアルのブラッシュアップを継続する。

(監修:Polaris Infotech 株式会社 代表 東野 誠(ひがしの まこと) )
(創業手帳編集部)

ご依頼・お問い合わせフォーム

下記フォームからご希望内容を入力の上、送信ボタンを押してご依頼・お問い合わせください。

※専門家紹介のご依頼・お問い合わせをいただいても紹介料は一切発生しません。

お名前必須
お名前(ふりがな)必須
メールアドレス必須
電話(ご連絡のつく番号)必須
会社名・屋号(任意)
※起業前の方は未定とご記入ください。
郵便番号(任意)
都道府県必須

市区郡町村必須
番地(建物名等)(任意)
会社設立日必須

ご相談種類必須

ご紹介依頼・ご相談内容詳細必須
referrer
  • ご依頼にあたっては「プライバシーポリシー」へのご同意が必要となります。 ご同意の上、お進みください。
  • ご依頼内容によってはご希望に添えないケースもございますのであらかじめご了承ください。

sogyomae senmonka_shokai2

この記事に関連するタグ

この記事に関連する記事

創業手帳

創業時に役立つツール特集

カテゴリーから記事を探す