2. テクニカルライティングで考えたマニュアル作成
2-1 3段階のプロセスで考える
よいマニュアルを作成するために何から始めたらよいのだろうか
ここからは,テクニカルライティングを導入してマニュアルを作成するにはどのように進めたらよいのかを解説します.ただし,このコーナーは当ホームページのイントロダクションですので考え方と手法の一例を紹介するにとどめます.
プロセスの各ステップの詳細やここで取り上げた以外の手法は当ホームページの他のコーナーで解説しています.是非そちらをご覧ください.
どのような仕事も効率よく進めるには正しいプロセスを踏むことが重要になります.マニュアルにおいてもその限りではありません.先に,「マニュアルを作るには読者指向にならなけばならない」と述べました.そこでまず読者にどのように伝えるのかを
企画(構成を検討して目次を作る)
することからスタートします.企画をした上で,
構成(技術情報を読者向けに執筆する)
,さらに
演出(ビジュアル化)
する,全3段階のプロセスで考えるのがよいと思います.
よくあるマニュアル作りの進め方で,きちんとした企画をせずいきなり執筆を始め不具合があれば後から直すということがあります.時間的なことを考えると執筆に要する時間より企画(内容・構成の検討)に要する時間のほうか格段に短いはずです.これを惜しんだために後の工程でかけなくてよい時間をかけてしまうのは適切とはいえません.
プロセスの進め方としては
企画(目次を作る)→構成(執筆する)→演出(ビジュアル化する)
の順序ですが,「読者指向になる」という意味では,「最終的にどのように読者の目に触れ理解されるのか」という読者の視点から逆算して,演出(ビジュアル化)を念頭におきながら目次を作り執筆することがポイントです.
イラストを追加したりページのデザインを工夫したマニュアルをよく見かけます.しかし,その多くには目次や執筆の内容とはあまり無関係に,ただお化粧をしただけのみかけの演出が目に付くことがあります.読者の眼はさほどに甘いものではありません.読者の理解という必然から生まれた演出(ビジュアル化)こそ重要であり,みせかけの演出は製作費の浪費に過ぎません.
各ステップで何をなすべきか
前項で述べた3段階を整理してみます.この考え方はマニュアルに限らず多くの文書に応用できると思います.
Step1[企画
(目次作り)
]:技術情報をいかに変換して受け手に伝えるか,その基本的指針を検討・決定する
誰のために,何のためにマニュルを作のか.受け手(読者)のことをまず考えてみましょう.
その上で,「目次」として具体的に内容構成を表現してみてください.技術仕様書をそのまま目次にすることは避けるべきです.
Step2[構成
(執筆)
]:情報を分解し,これを企画方針に基づいて再構築する
ベースとなる技術情報をいったん分解し,目次にそって統合・関連付け,再構築します.
正確でわかりやすい文章で表現するためには,「執筆のルール」や「わかりやすい文章を書くためにチェックポイント」を考慮してください.
Step3[演出
(ビジュアル化)
]:再構築された情報を構造化,イラスト化,さらにレイアウトすることにより視覚的な演出を行う
視覚的な理解を取り入れることを検討しましょう.
図2 マニュアル作成フロー:それぞれのステップの
Key Words
については各ステップで説明します
次ページに進む(ボタンをクリックしてください)
第1部 わかりやすいマニュアルを作るために
-マニュアル作成の進め方-
Copyright:Takaaki-YAMANOUCHI/1995-2001
山之内孝明/(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.