今回は,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その49)」です。「マンガで学ぼう・ダウンロードコーナー」の「コミュニケーションの特徴の違いを認識しよう」の資料と同じ内容です(内容の一部を改変しています)。
■コミュニケーションの特徴の違いを明確にする
会話をすることも技術文書を書くこともコミュニケーションです。しかし,これらのコミュニケーションにはその特徴に違いがあります。これを明確にすることで内容が明確に伝わる技術文書を書く必要性がわかります。
■会話を通したコミュニケーションの特徴
会話を通したコミュニケーションの特徴は,その場で内容が確認できることです。会話を通したコミュニケーションでは話し手と聞き手が対面で会話をするので(オンラインの場合も含む),会話の中でわからないことがあればその場でその内容が確認できます。その場でその内容が確認できることは対面ではない電話での会話の場合も同じです。
■技術文書を通したコミュニケーションの特徴
技術文書を通したコミュニケーションの特徴は,その場で内容が確認できる場合とできない場合があることです。書き手と読み手が対面している場合と対面していない場合があるからです。
例えば,会議の場合,その資料(技術文書)の中でわからないことがあったときにはその場でその内容が確認できます。書き手と読み手が対面しているからです。
これに対して,例えば,仕事の関係者から送られてきたメールの中でわからないことがあってもその場でその内容が確認できません。書き手と読み手が対面していないからです。内容を確認するためのメールを送ったり電話で内容を確認したりする必要があります。これらは無駄な時間です。また,メールの内容を間違って理解したまま仕事を続けた結果仕事の手戻りが起こるかもしれません。
■技術文書を通したコミュニケーションで必要なこと
技術文書を通したコミュニケーションで必要なこととは,内容が明確に伝わる技術文書を書くことです。内容が明確に伝わる技術文書を書けば内容の確認のための無駄な時間が発生しません。また,内容を間違って理解したことによる仕事の手戻りも防げます。すなわち,内容が明確に伝わる技術文書を書くことは,仕事を確実に進めるための条件の一つです。
次回に続きます。
【参考文献】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日