「マンガでわかる技術文書の書き方」の内容の説明の第4回として,「全面改訂版での追加内容について」を説明します。
全面改訂版では以下の2つの内容を追加しました。
*1章:内容が明確に伝わる技術文書を書く
*6章:内容が明確に伝わる技術文書を書くうえで必要なこと
内容が明確に伝わる技術文書を書くうえで必要なことなので,この2つの内容を全面改訂版で追加しました。
_
■内容が明確に伝わる技術文書を書く
この中では,「技術文書を書く目的」,「『内容が伝わる技術文書』と『内容が“明確に”伝わる技術文書』の違い」および「内容が明確に伝わる技術文書を書く理由」を解説しました。これらの3項目の内容はすべて関係しています。技術文書を書く目的がわかると内容が明確に伝わる技術文書を書く理由(=書かなければならない理由)もわかります。
■内容が明確に伝わる技術文書を書くうえで必要なこと
内容が明確に伝わる技術文書を書くうえで必要なこととは以下の2つの内容です。
①伝える内容を明確に理解していること
②頭の中を整理すること
内容が明確に伝わる技術文書を書くためにはこれらのことを認識する必要があります。
_
「内容が明確に伝わる技術文書を書くうえで必要なこと」については別ブログでこれらの内容を説明します。
次回に続きます。