

執筆要領・用語抜粋の用意
| |
マニュアルは「わかりやすい内容」,「正確な表現である」とともに,見出しおよび文章の体裁や用語が統一されていなければなりません.それには,技術文書を執筆する際の「より所」となるいくつかのルールを執筆要領と用語抜粋として定めておくのが有効です. |
執筆要領・用語抜粋の主旨
執筆要領・用語抜粋を作っておけば,書式や用語を統一するのに役立ちます.
とりわけ,複数の執筆者で分担する場合に有効です.当セクションここで提唱するのは,
文書の書式をまとめた「執筆要領」と先に述べた「一般用語抜粋」,「専門用語抜粋」の3部構成です.

「執筆要領」の構成
「執筆要領」は,文書作成の原則集です.いわゆる「上手な文章の書き方」ではありません.ワープロで文書を作成する際,「見出しの付け方」,「図・表の作り方・入れ方」などの最低限まもるべき基本事項と書式が中心です.


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

実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright:Takaaki-YAMANOUCHI/2002-2010
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
takaaki@yamanouchi-yri.com