マニュアル制作に必要なこと

マニュアル制作に必要なこと

新規マニュアルを制作する場合、分冊構成が決まり、各分冊の目次構成が決まれば、あとは仕様を確認しながらライティングを開始すればいい！と思ったら大間違い。
マニュアルは一般の雑誌などとは異なり、説明ページのタイトルや概要、操作説明から注意書きに至るまでデザインが統一され、表記もタイトルは「体言止め／である調」にする、概要や注意書きは「ですます調」にするなど、事細かに記載ルールが決められていて、どのページを見ても同じパターンで統一されている。

では、なぜパターンを統一するのか。それは、説明する機能ごとにデザインや表記がバラバラでは、ユーザーがその機能説明を理解し、操作するまでに無駄な労力が必要になるからだ。
その無駄な労力を極力省くために、タイトルにはその機能が明確になる名称にして、概要を見ればその機能の概略がわかるようにする。操作説明はどの機能も同じパターンで手順を記載して、注意書きは「注意アイコン」で明記する。このように、同じパターンで記載されていれば、どの機能の説明を読んでも、ユーザーが理解するのにかかる無駄な時間が不要となるのだ。

説明に使用する用語も規定しておく必要がある。常に同じ用語で説明することで、説明を読んだユーザーが余計な疑問を抱かずに理解できることになる。

前ページの説明では「コピー」だったが、次ページでは「複写」になっていたり、「ディスプレイ」が「モニター」、「起動する」が「開始する」になっていたりなど、ライターは同じものとして書いたつもりでも、ユーザーには表記が違うだけで、同じことなのか理解することに迷うことになる。

判断に迷うことで、マニュアルの説明に疑問を持って操作したり、解釈を誤って操作したりする。それが原因で最悪の場合、ユーザーに負傷を負わせたり、機器が故障したりする可能性もあり得る。

そのほかにも、マニュアルを一人のライターがすべて書くのであれば、整合性や統一性を取りながら書くことができる。しかし、マニュアルのページ数が多く、納期も限られている場合は、複数のライターが分担して書くことになる。結果、書く人により記載ルールが異なり、 整合性や統一性が保たれていないマニュアルとなってしまう。

そうならないために必要になるのが、記載ルールを確認できる『執筆規約』の存在である。

執筆規約は、ライティングを開始する前に、マニュアルのタイトルや説明文の文体や用語、スタイルについて、具体的な記載事例をもとに記載ルールを決めたものである。
たとえば、編・章・節・項などのタイトルの文体やスタイルはどうするか、機能概要のリード文に記載する内容はどうするか、操作説明の手順に記載する表記スタイルはどうするかなどを決める。

執筆規約に正解はなく、制作する部署やマニュアルごとに、対象ユーザーに合わせて使用する用語や説明する内容を規定する。マニュアル担当者が中心となってたたき台を作成し、より多くの関連部署の意見を聞きながら随時更新し、育てていくことになる。

執筆規約のたたき台を作成する第一歩は、編・章・節・項で何を記載するのかを明確にしていくことだ。編・章・節・項の分類は、目次構成と大きく関わってくるが、マニュアルで説明する機能をどう分類し、各機能の説明はどのレベルで説明するかを決める必要がある。

説明する機能が多い場合は、「基本編」や「リファレンス編」「トラブル対処編」など機能を分類すると、ユーザーは目的に合わせて説明を確認できる。
この場合、各編の内容は別冊マニュアルでまとめられる量となる。またタイトル名称も、具体的な機能名称では説明範囲が狭くなるので、上記の例のような漠然とした検索目的に応える名称にする。「編」レベルで分類するほど機能がない場合は、無理に「編」を設ける必要はなく、「章」レベルから説明しても問題ない。

章レベルは、各編または１冊のマニュアルの中で、機能を分類するための名称にする。
例えば、

リファレンス編（リファレンスマニュアル）
・第1章 基本操作
・第2章 詳細な機能
・第3章 メンテナンス
などの章タイトルに分けることで、各機能の説明をいずれかに分類することができる。つまり、機能説明をまとめる名称が章タイトルに必要となる。通常は、機能名称のタイトルと明確に分類するために、「基本操作」「印刷」「メンテナンス」など、名詞を使用する場合が多い。

節レベルは、最終的な機能説明となる「項」レベルをまとめるタイトル名になる。例えば、「第２章 詳細な機能」で、メニュー項目を説明するときに、トップメニューを節タイトルにすることで、トップメニューにぶら下がる機能の分類が明確になる。
具体的には、
・第2章 詳細な機能
　- 2‐1 編集メニュー
　- 2‐2 表示メニュー
のようにすることで、最終的な説明レベルである「項」レベルの分類が明確になり、検索性にも十分応えることができるようになる。

各機能は、項レベルで最終的な説明をするのが理想だ。そして、タイトル名には、その機能が明確になる名称にするとよい。
例えば、「第2章 詳細な機能」の「2‐1 編集メニュー」で、コピー操作の説明を記載するときは、「2‐1‐1 文字をコピーする」などの名称にすることで、具体的な機能と目的が明確になる。
項レベルのタイトルを「である調」にするのか、「・・しましょう！」にするかは、マニュアル担当者がマニュアルごとに、対象ユーザーに合わせて決定していくことになる。
とある企業の執筆規約では、具体的な機能名称は使用禁止で、機能の使用目的をタイトル名にすることが規定されている。具体的には「アドレス帳を作成する」はNGで、「電話番号と住所を登録する」ならOKがもらえるのである。

項レベルで分岐した説明が必要な場合などに、その具体的なケースを見出しにして使用する。このケースは、あくまでも機能説明は項レベルであり、項レベルの中で場合分けをするケースのみに使用する。
例えば、項レベルの「ドライバーをインストールする」で使用するOSによって操作が分かれる場合は、「■Windowsの場合」「■macOSの場合」のように、見出しを付けてそれぞれの操作手順を説明する。

説明に使用する用語も、基準を明確にすることで整合性がとれ、統一感のあるマニュアルとなる。そして、その表記基準の対象となるのは、漢字や送り仮名、カタカナ、数字などである。

これらの用語を統一するためには、マニュアルの記載ルールを作成して明確にする必要がある。このとき、可能であれば製品の機能名や本体の部位名称など、他部門にかかわる名称についても、この記載ルールを元に名称を決定するとよい。マニュアルの説明と製品の機能名や部位名称の整合性が取れ、統一感のある表記になる。

マニュアルで使用する漢字は、ライターによって異なることが多いので、用字用語に関する記載ルールが必要となる。常用漢字表（平成22年内閣告示第2号）を基準にすれば問題はない。

ただし、常用漢字でも、マニュアルの説明ではひらがなで表記したほうがいい場合もある。ひらがなで表記したほうがいい常用漢字をピックアップし、漢字表を作成することをお勧めする。
例えば、「下さい」⇒「ください」、「出来る」⇒「できる」、「御案内」⇒「ご案内」などがある。常用漢字からピックアップしたものは、記載ルールに追加する。

この作業が面倒な場合は、市販の辞書を基準にすれば、記載ルールは明確になる。参考となる辞書としては『新用字用語辞典』（NHK編）、『朝日新聞の用語の手引き』（朝日新聞社）、『デジタル用語辞典』（日経BP）などがあげられる。

送り仮名も、ライターによって異なることが多いので、記載ルールが必要となる。よくある基準としては、活用のある語は活用語尾を送り、活用のない語は名詞扱いで送り仮名を付けないことにする場合が多い。

紛らわしい用語としては「細かい」「柔らかい」「現れる」「関わる」「上(あ)がる／上(のぼ)る」などがある。省略して使用する用語としては「表す」(△表わす)、「行う」(△行なう)、「断る」(△断わる)、「生れる」(△生まれる)、「押える」(△押さえる)などがあるので注意が必要だ。

そのほかにも、活用形や動詞と名詞で送り仮名が違う場合もあるので注意が必要だ。
「明らむ／明ける」「押す／押える」「呼び出す(動)／呼出・呼出し(名)」「申し込む(動) ／申込・申込み(名)」「読み取る(動)／読取・読取り(名)」

カタカナ表記の対象には「外来語」「擬声語／擬態語」「特定用語」（和製語／外来語から転化）があり、マニュアルの説明ではよく使用されるが、表記が統一されていない場合が多々ある。
そのため、マニュアルで使用するカタカナも記載ルールに登録することをお勧めする。

表記	使用例
外来語	「デザイン」「ファイル」「シェード」「ダイジェスト」「チェック」
擬声語／擬態語	「ピッ」「ピー」「ピポパ」「ツー」「カチッ」「ガタガタ」「ガチャ」
特定用語	「電源ボタン」「液晶パネル」「スマートフォン」「色ムラ」「ネジ」
長音表記	マイクロソフトを利用することが多いPCソフトやIT関連マニュアルは、マイクロソフトの長音表記に従ったカタカナの使用が推奨される。 マイクロソフトは、内閣告示第二号『外来語の表記』に基づき、カタカナの記載ルールを改訂した。英単語の末尾が「-er, -or，-ar」の用語は、カタカナ表記の末尾に長音（ー）を付加することになった。

マニュアルは横書きなので算用数字を使えば問題ないが、表記によって漢数字を使用したほうが自然な場合もある。そのため、数字についても記載ルールを明確にすることをお勧めする。

カッコの使用

カッコは種類が多く、マニュアルでも使用するケースが多々あるので記載ルールで明記しておくことが必要だ。例としては以下のような記載ルールがある。

そのほかにも、マニュアル制作には表記やデザインを統一するための規約がある。また、家電製品には、公正競争規約における特定用語や、「省エネ」や「節約」など使用できる用語にも制限がある。

こういった基準（記載ルール）、規約、制限を基に制作することによって、より読みやすく、理解しやすいマニュアルができるのだ。

---

---