【この連載の前回:“技術文書を書くこと”について考える(その2)へのリンク】
1.内容が明確に伝わる技術文書を書く理由
内容の伝達を成立させるために、内容が明確に伝わる技術文書を書く必要があります。これが、内容が明確に伝わる技術文書を書く理由です。内容が明確に伝わる技術文書を書くことで技術文書を書く目的(内容の伝達)が達成できます。
◆内容の伝達が成立しないメール(内容が明確に伝わらないメール)
社内技術論文は7月26日(月)までに技術第2部の佐藤までメールで送ってください。なお、提出期限を厳守してください。提出期限を過ぎた場合には社内技術論文を受理しません。
このメールは、社内技術論文の提出先とその提出日はメールの受信者に伝わります。しかし、提出期限の具体的な時間が書いてないためメールの受信者に内容が明確に伝わりません。提出期限が、「7月26日(月)の17時(勤務時間内)」なのか「7月26日(月)の23時59分」なのかがわかりません。このようなメールでは、技術第2部の佐藤さん(書き手)からメールの受信者(読み手)への内容の伝達が成立しません。このようなメールではメールを書く目的が達成できません。
◆内容の伝達が成立するメール(内容が明確に伝わるメール)
社内技術論文は7月26日(月)の17時(勤務時間内)までに技術第2部の佐藤までメールで送ってください。なお、提出期限を厳守してください。提出期限を過ぎた場合には社内技術論文を受理しません。
このメールは、メールの受信者に内容が明確に伝わります。提出期限の具体的な時間が書いてあるからです。このメールは、技術第2部の佐藤さん(書き手)からメールの受信者(読み手)への内容の伝達が成立します。このようなメールを書けばメールを書く目的が達成できます。
技術文書を書く目的は、「技術文書の書き手からその読み手に内容を伝達すること」です。内容が明確に伝わる技術文書を書くことで技術文書を書く目的が達成できます。ここでは、メールを書くことを例にして、内容が明確に伝わる技術文書を書く理由を解説しました。
内容...
【参考文献】
森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
◆関連解説記事「書くべきことを自分の頭の中ではっきりさせる」