「マンガでわかる技術文書の書き方」の内容の説明の第12回として,3つの視点の中の「内容が明確に伝わる技術文書を書くうえで必要なこと」を説明します。
内容が明確に伝わる技術文書を書くうえで必要なこととは以下の2項目です。
①伝える内容を明確に理解していること
②頭の中を整理すること
■伝える内容を明確に理解していること
内容が明確に伝わる技術文書を書くうえで「伝える内容を明確に理解していること」は重要です。「伝える力:池上彰著・PHPビジネス新書」を読むとこのことがよくわかります。
本書の中では,「理解したつもり」と「理解した」という言葉を使ってこの内容を解説しました。また,この内容は,2016年3月9日に掲載した「本質を理解する(パートⅠ)」というブログの内容と関係しています。
「内容を理解したつもり」の状態ではなく「内容を理解した」状態で書くことで内容が明確に伝わる技術文書を書くことができます。
■頭の中を整理すること
例えば,「報告書には,これを書こう,これを書かなきゃ,あれを書こう,あれも書かなきゃ・・・」のような頭の中が未整理の状態で一気に書き出すと,内容が伝わる技術文書(=内容が明確に伝わらない報告書)を書いてしまうことがあります。まず,自分の頭の中を整理してから技術文書を書いてください。
「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って技術文書を書くこととは,「頭の中を整理して技術文書を書くこと」と言い換えることもできます。
「内容が明確に伝わる技術文書を書くうえで必要なこと」に関する2項目は,内容が明確に伝わる技術文書を書くうえで非常に重要な内容です。しかし,これらのことがあまり認識されていないかもしれないので本書ではこれらの内容を書きました。
次回に続きます。