

執筆マニュアルの用意
| |
技術文書は「わかりやすい内容」,「正確な表現である」とともに,見出しおよび文章の体裁や用語が統一されていなければなりません.それには,技術文書を執筆する際の「より所」となるいくつかのルールを執筆マニュアルとして定めておくことです. |
執筆マニュアルの主旨
執筆マニュアルを作っておけば,また複数の執筆者で
文書を作成する場合にも書式や用語を統一するのに役立ちます.
執筆マニュアルの構成
ここで提唱する「執筆マニュアル」は,
文書の書式をまとめた「執筆要領」と先に述べた「一般用語抜粋」,「専門用語抜粋」の3部構成です.
執筆マニュアルのメリット
執筆マニュアルを用意しておくと,文書品質の向上とともに文書作成の効率化につながります.
体裁・用語の統一
ページ数の多い文書の場合,数人で分担して執筆する
場合があります.執筆者が違えば文章に多少の個人差がでるのはしかたがありません.しかし,用語や記号の使い方までまちまちでは文書の品質を下げてしまいます.「執筆マニュアル」という共通のより所があるのとないのでは完成した
文書の品質は大きく異なります.
執筆者の負担の軽減
執筆マニュアルがあると,執筆の途中で執筆者があれこれ迷うこと(無駄な時間)が少なくなります.また,より所がないと原稿の完成度が低くなってしまいます.その結果,後から修正するのに無意味な時間や手間がかかります.
ノウハウの蓄積
「執筆マニュアル」を一度作っておけば,ほかの
技術文書を作成する際に活用できます.また,専門用語や文章表現の事例など徐々に内容を追加してゆけばいつのまにかかなりのノウハウの蓄積になります.
次ページに進む(ボタンをクリックしてください)

テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
Copyright:Takaaki-YAMANOUCHI/2002-2006
山之内孝明/(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.