今回は,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その48)」です。
■4項目について
「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その29)」で以下のことを書きました。
以下の4項目を「理解・習得・実践」することで,内容が明確に伝わる技術文書を書くことができます。
①重要なことを理解する
②書き方の技術を習得する
③必要なことを理解する
④日々のオンザジョブトレーニングを実践する
■4項目は四位一体
この4項目をセットで学ぶことが,内容が明確に伝わる技術文書の書き方を学ぶうえでのポイントです。この4項目がすべて関連しているからです。「4項目がすべて関連している」とは以下のようなことです。
Ⅰ:「重要なことを理解する」を学ぶことで,「技術文書を書く目的=技術文書の書き手からその読み手に内容を伝達すること」がわかります。これがわかることで,技術文書を書くうえでの“書き手”と“読み手”の存在が明確になります。
Ⅱ:「書き方の技術を習得する」を学ぶことで,「技術文書の書き手とその読み手の違いの認識が,内容が明確に伝わる技術文書を書くうえで非常に重要」ということがわかります(書き方の第1原則)。
Ⅲ:「書き方の技術を習得する」を学ぶことで,「読み手の立場に立って,技術文書の構成を考えること(書き方の第2原則),「6つのルールと18の書き方」を使ってその構成に肉付けすることが重要」(書き方の第3原則)ということがわかります。。
Ⅳ:「必要なことを理解する」を学ぶことで,「内容が明確に伝わる技術文書を書くためには,自分の頭の中を整えることが必要」ということがわかります。
Ⅴ:「日々のオンザジョブトレーニングを実践する」を学ぶことで,「内容が明確に伝わる技術文書を書くためには,継続教育(日々のオンザジョブトレーニング)が必要」ということがわかります。
「重要なことを理解する」,「書き方の技術を習得する」,「必要なことを理解する」および「日々のオンザジョブトレーニングを実践する」の4項目はこのように関連しています。
この4項目は四位一体です。4項目がすべて関連しているからです。4項目をセットで学ぶことで,内容が明確に伝わる技術文書を書くために必要なことがすべて学べます。したがって,あらゆる技術文書,例えば,業務や研究の報告書,会議や打ち合わせの資料,メールなどの内容が明確に伝わるように書くことができます。
次回に続きます。
【参考文献】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日