

分担して執筆する際のポイント
|
ページ数が多いマニュアルを作成する際は、分担して執筆するのが一般的です。ところが、執筆者によって書き方がまちまちとなったり内容が偏ったりする場合があります。中核(まとめ役)となる執筆者と分担する執筆者ともにテクニカルライティングの知識と手法を共有して臨むのが、分担して執筆する際のポイントです。
|
陥りやすい事例−「準備不足型」と「ルール優先型」−
大雑把な見出し構成(章ランク程度)と流用したサンプルだけでマニュアル作成を進めると、表現あるいは内容に不統一が生じます。また、流用のサンプルだけではどのように表したらよいのかわからない箇所が必ず出てきます。その結果、迷って執筆が停滞したり、無理がある見出し構成に陥る場合があります。
誰かがまとめ役になって詳細な見出し構成と執筆ルールを作ってもうまく進まない場合があります。分担する執筆者に執筆するための知識と手法がなければ執筆ルールがかえって制約となるおそれがあります。
-
ごく簡単なマニュアルならばともかく、わかりやすいマニュアルを作成するのに必要な手法をすべてルール化(あるいは“マニュアル”化)するのは無理があります。ルール化できるのは
仕様書の範囲にすぎません。
-
「しなければならないこと/してはならないこと」に加えて各文章の書き方のレベルまでルール化しようとすると、ケース例あるいは例外が多すぎて収拾がつかなくなります。
-
マニュアルを作成するための簡単なマニュアルを作ったとしても、さまざまな条件への対応が必要なマニュアル
の作成に役立つとは思えません。同じ部署にいる人の行動マニュアルを作るのには使えるかもしれませんが、執筆者と読者が出会わないような製品マニュアルのレベルでは安易なアプローチは避けるべきです。

テクニカルライティングの知識と手法の共有
望ましいのは、「中核になる数名の執筆者」と「分担する執筆者」がでテクニカルライティングの基礎を共有している執筆体制です。
分担する執筆者がテクニカルライティングの知識と手法を共有していれば、見本ページと執筆要領に沿ってそれぞれの分担を工夫を加えながら執筆できます。
知識と手法を共有した執筆者がかかわれば執筆の効率化にもつながります。また、ノウハウが蓄積・継承され移動などによってメンバーが交代して執筆力が低下しません。

次ページに進む(ボタンをクリックしてください)

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