■「重要なことを理解する」についての整理
「内容が明確に伝わる技術文書を書くための4項目」のうち,「重要なことを理解する」に関して以下の項目に基づき解説しました。
①技術文書=コミュニケーションの手段
②技術文書を書く目的
③「内容が伝わる」と「内容が“明確に”伝わる」の違い
④内容が明確に伝わる技術文書
⑤内容が明確に伝わる技術文書を書く理由
技術文書を書く目的は,「技術文書の書き手からその読み手に内容を伝達すること」です。「技術文書=コミュニケーションの手段」と考えると「内容が明確に伝わる技術文書」を書くことの重要性がわかります。
■内容を伝達する意識を持つ
「内容を伝達するために技術文書を書く」という意識で技術文書を書いてください。例えば,業務報告書を書くことを考えます。業務を行ったときには業務の最後にその報告書を書きます。このとき,「業務の成果をまとめる」あるいは「業務の成果を記録として残す」という意識で業務報告書を書くと思います。このような意識だけではなく,「業務の成果(内容)を伝達するために業務報告書を書く」という意識で業務報告書を書いてください。
内容を伝達する意識を持つと技術文書を書く意識が変わります。例えば,「業務の成果(内容)を伝達するために業務報告書を書く」という意識を持つと業務報告書の書き方が変わります。「まとめる」あるいは「記録として残す」だけではなく「業務の成果(内容)を伝達する」という意識に変わるからです。「業務の成果(内容)を伝達するためには業務報告書をどのように書いたらよいか」と考えます。
これは,他の技術文書,例えば,会議・打ち合わせの資料やメールを書くときも同じです。「技術文書=コミュニケーションの手段」と考えて「内容を伝達する」という意識で技術文書を書いてください。
次回に続きます。
【参考文献】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日