■内容が明確に伝わる技術文書を書くための4項目
「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その29)」で,内容が明確に伝わる技術文書を書くための4項目を解説しました。以下の4項目注1)です。
ー
①重要なことを理解する
②書き方の技術を習得する
③必要なことを理解する
④日々のオンザジョブトレーニングを実践する
ー
注1):この4項目に基づき,セミナーや社員研修では「内容が明確に伝わる技術文書の書き方」の内容を解説しています。
ー
今回は,「③必要なことを理解する」について解説します。必要なこととは,「伝える内容を明確に理解していること」と「頭の中を整理すること」の2項目です。
■伝える内容を明確に理解していること
伝える内容を明確に理解していることで,内容が明確に伝わる技術文書を書くことができます。逆を言えば,「伝える内容が理解したつもり」では,内容が明確に伝わる技術文書を書くことができません。
ー
「理解したつもり」とは,伝える内容を自分は理解していると思っていても実際は理解していないことです。「理解したつもり」については,2016年3月11日に掲載した「本質を理解すること(パートⅢ)」をテーマにしたブログを参考にしてください。
ー
池上彰氏は「伝える力」の中で以下のことを書いています。
“「伝える」ために大事なこと。それはまず,自分自身がしっかり理解することです。自分がわかっていないと,相手に伝わるはずがないからです。”
この内容は,内容が明確に伝わる技術文書を書くうえで重要なことです。理解したつもりのレベルで書いた技術文書では内容が明確に伝わりません。
=
「“理解したつもり”から“理解した”へ」で内容が明確に伝わる技術文書を書くことができます。
■頭の中を整理すること
頭の中を整理して書くことも内容が明確に伝わる技術文書を書くための条件です。
ー
「この報告書には,これを書こう,これも書かなきゃ,あれを書こう,あれも書かなきゃ・・・」のような頭の中が未整理の状態で書くと内容が明確に伝わらない報告書を書いてしまいます。例えば,頭の中が未整理の状態で書くと,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その4)」で書いたように「車の主な種類」を文の羅列で書いてしまいます。
ー
「必要なことを理解する(伝える内容を明確に理解していること・頭の中を整理すること)」も内容が明確に伝わる技術文書を書くうえで重要です。
次回に続きます。
【参考文献】
池上彰著,「伝える力」,PHP研究所,平成19年5月2日
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日