マニュアル作成に関する検査

　マニュアルとは、科学技術的な内容を扱った文書であって、読者（ユーザー）を意識してソフトウエア、ハードウエアなどの説明、操作法を示したものを云う。科学技術レポートのまとめ方に関しては、ISO 5966、並びに SIST 09において一般的な規格が定められている。ここで説明するマニュアルに関する検査は、基本的に上記の規格との整合性を較べることで行なわれる。

　学術雑誌の作成においては、雑誌の物理的な構成は編集委員会が規則を定め、内容についての審査は論文委員会などで行なわれる。この制度は、学術雑誌の権威を高めるのに役立つ。また著名な出版会社では、自社の出版物の評価を高めるために、独自の編集スタイルを保ち、それを誇りにしていることが多い。マニュアルに関しては、公平な審査を外部の機関が行なう、という制度はない。したがって、現在の時点では、マニュアルを検査することは一種の消費者テストに相当している。

　自分でマニュアルなどを作る際、既存のマニュアルを見て、善い悪いの検査をして勉強するのが役に立つ。以下の項目はそのような教育目的を考えて制作した。

1. 用紙は規格寸法に合っているか。

用紙寸法は、JIS 規格の A4,B5,A5 などが望ましい。寸法が特殊であるのは、書架での保存に支障が生ずる。

2. 用紙（表紙も含めて）の質は適当か。

紙の色が悪く、字が読み難い。紙が薄すぎて、とり扱い難いなど。

3. 余白は適当か。綴じ方は正しいか。

原則として左開きになるように綴じる。用紙の片面だけに印刷してある場合も、紙の両面に印刷して綴じることを考えておかなければならない。

4. 書架に並べて保存することが考えられているか。

表紙、背表紙、裏表紙は書誌事項を記述するためと、補強の目的を持っていて、レポート本体からは独立である。ページ数の少ない薄い印刷物は、厚手の表紙をつけて背文字が読める工夫をするか、バインダに綴じこんで使用する際の見出しの注意を付けるべきである。

5. バインダなどは規格品か。

市販のバインダは多種多様であるが、ISO 規格では紙の余白における穴の位置と間隔が決められている。厚手の表紙も同じであるが、バインダの寸法は用紙寸法に対して決められている。

6. ページの切り方は正しい方法か。

ページは、見開きの右が奇数になるようにつける。用紙の片面だけを使う場合でも、用紙の両面に印刷して綴じることを考えておく。ページの切り方は、全部を通して一連番号がよい。製本されていたり、書物になっているものは、目次や序文などを、本文と別のページをつけることもできる。章ごとに、章番号単位のページを付けてもよいが、全体を通したページも必要である。バインダに差し込むように作られた、バラの用紙を使うのは、基本的に正しくない。

7. 章などの大項目は奇数ページで始まっているか。

章の始めは、必らず奇数ページとし、その前が奇数ページで終わっているときは、空白のページを入れるか、章の終わりであることを示しておかねばならない。

---

3.　構成に関する検査項目 --- 3.1 表紙と書誌事項

8. 表題は判りやすく、適切に付けられているか。

表題は、全角で40文字以内で、適切なキーワードを含ませるのが良い。なるべくなら、副題などをつけない。

9. 発行の日付はあるか、また改訂の版番号などがあるか。

ソフトウエアは変化が早いので、日付、版番号は特に大切である。時々、ある時期の古い版が必要になることもある。バインダに差し替える方式のマニュアルであると、新旧の区別に混乱することがある。

10. 著作者、発行者が書いてあるか。

著作権は著作者が持ち、出版権は発行者が持つ。マニュアルでは、両者が同じで、企業名であることが多い。

11. 問い合わせ先の住所、電話番号などがあるか。

書店で取り扱わない印刷物では、特にこの情報が大切である。

12. レポート番号、ブック番号（ISBNなど）などがついているか。

レポート形式の出版物は、発行者の責任でレポート番号を付けなければならない。最近の図書には、国際図書番号(ISBN)がついているはずである。

---

3.2 前書などの部分

13. 自社の商標、著作権の宣言、注意事項などがあるか。

著者、発行者が明記されていれば、特に断らなくても著作権は成立つ。著作権が明瞭に宣言されているものは、引用などの場合に書面での承認と、場合によると相応の経費を要求することもある。

14. 編集のデザイン、イラスト作成などの協力者も示してあるか。

謝辞(Acknowledgement) である。ここでは、DTP(desk top publishing)やワードプロセッサのソフトウエアが書かれることが多くなった。

15. 他社の商標、ライセンスなどの承認事項があるか。

例えば、DOS(disk operating system)は普通名詞並みに使うことができるが、MS-DOSは登録された固有名詞である。

16. マニュアルの概要、使い方などについて説明があるか。

レポートにおける抄録(Abstract)は、非常に重要な位置付けを持っている。マニュアルは、ページの最初から順に読むとは限らないから、個々の章の簡単な紹介と相互の関連などを説明した章(Overview)があるのが良い。ただし、序文とは本文と切り離しても差し支えないことが書かれるものである。

17. ユーザーの知識についてのガイダンスがあるか。

マニュアルでは、Tutorialという名称が良く用いられる。多くのマニュアルが陥りやすい点は、著者が自分の知識の範囲で文章を書いていることにあり、ユーザーの知識程度に思い遣りが欠けていることである。

18. 参考にする別のマニュアルの情報があるか。

総てのことを一冊のマニュアルにまとめることは出来ない。むしろ、欲張って一冊にまとめるよりも、項目別の別冊のマニュアルにするか、他のマニュアルなどを含め、参考資料の情報をまとめるのが良い。

19. 参照する JIS, ISO などの規格の情報があるか。

何かの説明をするとき、規格や基準で呼ばれることが多い。例えばJISの漢字コードなどと引用するが、何処かでその規格の正式な名称番号をあげておく必要がある。

20. 略号、記号などの説明があるか。

コンピュータに関連する文書は、略号や記号が氾濫する。これらは一種の方言であるので、使っている本人には理解できても、第三者にも常識であるとは限らない。

21. マニュアルの使い方、例示などがあるか。

辞書にある凡例がこれに当たる。プログラミング言語ではステートメントの記述法などに当たる。そのマニュアルだけで意味が特別に決められた用語を定義することもある。

22. 目次はあるか。

ごく短い文書を例外として、目次は必須である。

23. 図版、表についても目次があるか。

図や表についても目次があるのは、編集がしっかりしている一つの証拠になる。

24. 用語集(Glossary)がついているか。

用語集は、巻末につけるのが普通である。用語は、JIS などで定義されているものを第一義的に使うようにする。本文中で説明なしに使われるとき、ゴシック文字などで書いておいて、用語集に説明があることを示すこともある。

25. 索引(Index) があるか。

索引のないマニュアルは最も品質的に劣ると考えても良い。ただし、コマンドのマニュアルの様に、辞書なみにアルファベット順に項目が並んでいるものは、目次と索引の区別を付けにくい構成もある。

---

3.3 章、節、項の構成

26. 全体のページ数は適当か、多すぎないか。

何事にも扱いやすい大きさがあるものである。一度眼を通せば済む部分と、使う頻度の高いページがあるのは仕方がない。百科辞書の様に総てを網羅するものと、日常使うものとは編集の思想が異なってしかるべきであろう。

27. 章、節、項の番号つけ方は適切か。

番号は、算用数字と点を使って、1, 2, 3, 2.3, 3.2.1 などとする。項目を四つ以上に細分するのは避ける。

28. 章、節、項に適切な表題(title) があるか。

箇条書きにするときは表題を付けなくても良い。

29. ・図につける番号、見出し(caption) は適切か。

図には全体を通した一連番号を振るか、章毎に通した番号を振る。

30. 表につける番号、見出しは適切か。

表も図と同じく全体を通して番号を振るか、章単位で番号をつける。

31. 付録があるならば、その番号付けは適切か。

付録は、付録 A、付録 B、付録 C･･･ の様にする。もし章立てにするなら、A1, B1.2, などの様にする。付録は、本来別の冊子とするものを、ユーザーの便を図って作成添付する性質のものである。従って、索引の様に本文のページを参照する記述はないし、また、本文から付録を参照する引用は用いない。引用は参考文献並みに扱う。

32. 付録にある図、表には独立の番号をつけているか。

付録の図、表は、その付録の中だけで参照されるべきものである。

---

3.4 文章作法

33. 文章の主語は述語で完結しているか。

日本語は、主語が省略されて、なんとなく意味が通じるので、論理的に記述するときは主語、述語の対比を意識すると良い。主語を意味する「は」「も」の後に読点「、」をつける。「が」の後に読点はなくて良い。

34. 文章のスタイルに調和があり、読みやすいか。

英語の原典から翻訳したものは、いわゆる翻訳調になって日本語としてこなれない。一方、くだけ過ぎるのも下品になる。言葉遣いに節度が欲しい。

35. 文末の表現に規則があるか。

英語では、「しなさい」を表現するのにshall, must,などと共に動詞の命令形を使う。「するのがよい」は、should, recommend などが使われる。このほか、助動詞の canなどがあって、厳密な使い分けがされる。日本語でこの表現が曖昧になりやすい。

36. 用語は適切か、説明のない専門用語が使われていないか。

読んで意味が判らない用語があったとき、それが用語集(Glossary)に載せてあるかどうかを調べる。また、索引を引いて、それが最初に現われているところで良く説明されているかを調べる。

37. 英語やカタカナ言葉を多用していないか。

英語の表現を日本語に翻訳しにくいことは、少なくない。英語の読みをカタカナで書くと同時に、元の綴りを紹介しておく注意が必要である。出来れば、標準の用語があればそれを用い、自分流の訳語をあてはめるときは、言語も付けておく。

38. 一つの文の長さが長すぎないか。

一つの文は、短いほどよい。二つ以上の文に分けることが出来るものは、分ける。

39. 適当な長さのパラグラフに分けて書かれているか。

ある、まとまりのある文章を段落(paragraph) にまとめる。その大きさは、400字くらいが読みやすい。パラグラフの切れ目は一行分の空白を開けるのが良い。

40. 二重否定など、判りにくい言い回しはないか。

文学的な言い回しをさけて、誤解が起きない文にする。「････を知らなければ、････が判らない」など。

41. 間接法（受動態）を多用していないか。

丁寧な言い回しをするとき、日本語では受動態を使いやすい。直接法で意味が通じる様に表現する。

42. 引用の方法は適切か、脚注やノートが適切か。

そのページに書くのが脚注やノートであって、他のページや別の資料を参考にする引用や参照と異なる。

43. 曖昧な参照や引用がないか。

参照は、「前に述べたように」「後で説明する」などの曖昧な指示を避け、例えば2.4節の第二パラグラフ」の様な指示が適している。ただし、ページと行番号で指定するのは、編集処理で位置が変化するので避けたほうが良い。

44. 句読点は適切か。

句点「。」、読点「、」の他に、「・」、「：」、「；」などには編集上の規則があるので、自己流にならないようにする。「！」や「？」などの多用を避ける。

45. 用字、用語、送りがな、などの誤りや不統一はないか。

日本語ワードプロセッサを使うことによる用字、用語の誤りが目立つ。これは、編集や校正の専門家の不足が響いている。カナ表記の揺れ、「ワープロ」、「ワードプロセッサ」、「ワードプロセサー」などに注意する。送りがなの規則も難しい。「組み合わせ」、「組合わせ」などの混用に注意する。

---

3.5 編集およびレイアウト

46. ページ構成は、全体を通して統一が取れているか。

編集およびレイアウトは全体のデザインに関するものである。マニュアルの様な実用書に類する印刷物では、カタログの様に派手なデザインは良くない。

47. 図、表の作成方法は、マニュアルを通して統一されているか。

線図を主体とした工業製図は厳密な規格がある。なるべくなら、色を使わなくてもよい様にする。図も表も、なるべく不要と思われるものを省き、大きめに書く。

48. 図、表とそれを引用した文が同じページにあるか。

出来るだけ、図表は、それを引用する文章と同じページにおくか、見開きで見える所に置く。図表をあちらこちらで参照するのを避けるには、図、表の内容を欲張らず、論点の所を強調するようにして、複数の図、表にわける。

49. 図、表は判りやすいか、ページ内の位置は適当か。

図、表の位置は、それが引用された文章のすぐ下にあるのが原則である。

50. 一ページの文書分量は適当か。

なるべくなら、一つの事項の説明がページを単位としてまとまっているのがよい。文字数が多すぎるものは、数行単位のパラグラフに分ける、などの様に、読み易さを助け、内容の論理的なかたまりが分離できるような構成がよい。

51. 活字の寸法、種類、組合わせは適当か。

活字の種類を多用するのは避ける。ゴシック、斜体、反転などの強調文字を使う場合、その使う基準を凡例などに解説しておくべきである。色を変えて強調する方法は良くない。

52. 意味のない漫画やイラスト、カラーを多用していないか。

一種の漫画ブームに乗って、挿し絵的に漫画を使うのは避ける。説明図に用いるイラストにも、透視図の基本を踏まえるなどの節度が欲しい。コマーシャルでアイドルの写真を使う様な、ムードに流されるイラストを使うべきでない。イラストなどは、作者の著作権についての配慮が必要である。

---

3.6 内容について

53. 主観的な表現はないか。

例えば「このたびは、****をお買い上げいただきまして、誠にありがとうございます」の様な文はそぐはない。

54. 章の組立て、順番に工夫が必要ではないか。

説明が後先になる様な構成が時々ある。後の章で説明することを、前の章で参照するのは、注意が足りない構成である。

55. 箇条書きにした方が判りやすくならないか。

文章で長々と書いて説明するよりは、箇条書きにするほうが良いものがある。特に、手続きを説明するときに有効である。また、流れ図の様なチャートにした方が良い、などのこともあるが、審査の際の検査官の個人的なコメントになるであろう。

56. 表にまとめたり、グラフにする方が判りやすくならないか。

文章で説明するのに対して、視覚に訴える表現は、多くの情報を伝えることができる。しかし、その反面、情報を読み落とす危険も増える。