|
いかなる作業も、決めるべき事項を決めてから臨めば効率と品質が向上します。マニュアル作成も同様です。執筆の途中で迷うであろう事項を最小限にするために、文書書式（見出し、図・表などさまざまな書式の総称）と用字用語（文書を作成する際に用いる字と語、例：漢字書きとひらがな書きの使い分け）をあらかじめルール化しておくことを薦めます。 また、マニュアルは一般的な文書書式の規範に基づいている必要があります。変則的にならないように、多くのマニュアルで定着した文書書式を選ぶことを薦めます。 |
当サイトの「マニュアル作成の進め方」でも述べましたが、「マニュアル執筆キット」とはこれから作成しようとするマニュアルの仕様書ともよべる文書セットです。
「見本ページ（＋留意事項）」、「チェック項目」、「執筆要領・用語抜粋」と「見出し構成」で構成されます。
マニュアルを作成する際に選んだ文書書式を「執筆要領」と「見本ページ（＋留意事項）」に表しておけば、執筆時の確認にもなりますし数人で分担して執筆する際に有効です。
同様に「用語抜粋」を用意しておけば、一般用語および専門用語の統一につながります。
ここで留意しておきたいのは、「マニュアル執筆キット」はマニュアルの仕様書に相当する文書セットであって、「これさえあればマニュアルを作成できる」訳ではないという点です。
製品を開発する際と同様です。仕様書があっても技術がなければ仕様を達成できません。マニュアルの作成にあたっても、作成技術に相当する「テクニカルライティングの手法」を導入されることを薦めます。
|
上記の主旨により、当社ではコンサルティングおよびセミナー以外で「マニュアル執筆キット（テンプレート版）」の配布を実施しておりません。 |
次ページに進む（ボタンをクリックしてください）マニュアルを作成する際の基本をお伝えして、テクニカルライティングへの関心をおもちいただくのが当コーナーの主旨です。
当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり、これが皆様のお役に立てば誠に幸いです。ただし、内容の一部あるいは全部の転載（他のWebサイトや他の出版物、等に収録・再配布する） および当著作物の二次使用を禁じます。
上記の主旨より、当コーナーはご覧いただいた方々に議論を呈することを目的としておりません。当社のテクニカルライティングセミナー、文書改善研修およびコンサルティングに関するお問合せ以外には、お答えいたしかねる場合がありますのであらかじめご了承ください。
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明／有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.