「伝えたつもりの技術文書」を書く原因と書かないための方法（その２）

投稿日 2024-06-11

「伝えたつもりの技術文書」を書く原因と書かないための方法（その１）では、「伝えたつもりの技術文書」について解説しました。今回は、伝えたつもりの技術文書を書く原因と伝えたつもりの技術文書を書かないための具体的な方法について解説します。

【目次】

1. 伝えたつもりの技術文書を書く原因

伝えたつもりの技術文書を書く原因は、書き手と読み手の違いを認識していないことです^注1）。書き手と読み手の違いを認識していないと、つまり、書き手とは知っている人、読み手とは知らない人ということを認識していないと、例えば「中堅技術者」の定義（具体的な入社後の年数）を書かずにメールを送ります^注2）。「自分（書き手）は中堅技術者の具体的な入社後の年数が頭の中にあるが（知っているが）、メールを読む社員（読み手）は中堅技術者の具体的な入社後の年数がわからない（具体的な入社後の年数を知らない）」ということに気が付かないからです。

書き手と読み手の違いを認識しないで自分の頭の中にあることを単に書き出すだけでは伝えたつもりの技術文書を書くリスクが高くなります。

注1）：「内容が明確に伝わる技術文書の書き方（その2）～（その8）」を参照

注2）：「伝えたつもりの技術文書」を書く原因と書かないための方法（その１）を参照

2. 伝えたつもりの技術文書を書かないための方法

（１）性善説ではなく性悪説で考える

伝えたつもりの技術文書を書かないための方法とは、自分が書いた技術文書を読み手に渡す前に「伝えたつもり」で書いてある箇所の有無を確認し「伝えたつもり」の箇所が見つかったらこれを修正することです。

自分が書いた技術文書を読み手に渡す前に内容を必ず確認（チェック）すると思います。例えば、会議の資料を作成したらそれを一度読み直し内容を確認すると思います。メールを送るときも送る前に内容を確認すると思います。このとき「伝えたつもり」で書いてある箇所の有無を同時に確認します。この作業をすることで「伝えたつもり」に気が付き「この箇所を修正しよう」となります。

伝えたつもりの技術文書はその技術文書を書いた本人（書き手）が「伝えたつもり」になっているためその対応が厄介です。そのため「どこか伝えたつもりになっているところがあるのではないか？」という意識を持って内容を確認する必要があります。これは、性悪説のような考え方です。性善説のような考え方を持っていると「伝えたつもり」で書いてある箇所を見落とします。