技術文書の図のポイント
「技術文書は図が中心」あるいは「文章で表すよりも図で表したほうが簡単でわかりやすい」という意見があります.技術文書のみならず実用文書では図が重要な“理解の要素”であることに間違いはありません.
かといって,「とにかく図を描けばよい」というわけではありません.目次構成や段落構成のように,図にも「構成」,「主題」,「結論」がおり込まれている必要があります.また,図と本文(段落)が適切に対応していなければなりません.さらには図の特徴(見る理解)に文の特徴(読む理解)を加える工夫もしなければなりません.
しばしば,報告文書の冒頭で詳細な「全体概要図」あるいは「システム構成図」を掲載している例を見かけます.これでは予備知識が少ない読者に必要以上に詳細な情報を与え,読者に“理解の負担”を強いていることになってしまいます.
また,ユーザ向けの製品解説に専門の技術者にしか理解できないような図を十分な解説もせずに使っている例を見かけます.その製品に初めて相対する読者は「その図が何を意味し,図から何を理解すればいいのか」混乱してしまうことがあります.図が正しければ誰でも理解できるわけではなく,文書の構成や読者に応じて図に情報を追加したり場合によっては図を簡略化する工夫が必要になります.
[当社出張開催セミナー「わかりやすい技術文書の作成手法<技術報告・研究報告編>」から抜粋]
次のページに進む
(ボタンをクリックしてください)
<
当コーナーの閲覧にあたり
>
当コーナーで使用する図・表および内容は当社の出張開催形式のセミナー「
テクニカルライティングで考えるわかりやすい
技術文書の作成手法
<
技術報告・研究報告編
>
」, 「(同)
<
製品解説・技術解説編
>
」,(同)
<
報告文書+解説文書編
>
」,からの抜粋です.
* したがって,報告文書を対象にした図と解説文書を対象にした図が混在することをご了承ください.
当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり,これが皆様のお役に立てば誠に幸いです.ただし,内容の一部あるいは全部を引用・転載(Webサイトや出版物などに収録・再配布)する,あるいは当著作物を二次使用することはご遠慮ください.
テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
Copyright:Takaaki-YAMANOUCHI/2002-2006
山之内孝明/(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
takaaki@yamanouchi-yri.com