1. “伝えたつもりの技術文書”とは
伝えたつもりの技術文書とは、書いた本人(書き手)は読み手に伝わっていると思っている内容でも、それを読む人(読み手)にその内容が明確に伝わっていない技術文書のことです。つまり、内容が明確に伝わらない技術文書のことです。
伝えたつもりの技術文書を書くことで、以下のような重大なことが起こる可能性があります注1)。
- ①技術文書を書く目的が達成できないこと
- ②読み手の仕事の時間を奪うこと
- ③仕事の手戻りがあること
注1):「“内容が明確に伝わらない技術文書”を書くことで起こる重大なこと」の記事参照:4793
2. “伝えたつもりの技術文書”の具体的な例
ここで、伝えたつもりの技術文書の具体的な例を『 』内に示します。例えば、以下のようなメールが社員に送られてきたとします。
『 中堅技術者を対象にして社内技術論文を募集します。過去に担当した業務に関する技術を対象とします。社内技術論文の提出を希望する社員は技術管理部の山田まで連絡してください。社内技術論文の提出を希望する社員に、社内技術論文のテーマの選定方法、執筆方法、提出期限などの詳細な作成規定をメールでお送りします。』
このメールは、伝えたつもりの技術文書(メール)です。中堅技術者の定義と応募の希望に関する連絡方法(連絡手段)が不明確だからです。また、文の羅列で書いているのでメールの内容が頭の中にダラダラと入ってきます(=内容が明確に伝わらない)。
メールを書いた山田さんの頭の中には、例えば、以下のような内容があったのかもしれません。
- ①「社内技術論文の応募のお知らせ」と「応募の方法」を伝えること
- ② 中堅技術者とは入社4年目~8年目までの社員のこと
- ③「応募すること」を書いたメールを山田まで送ること
しかし、これらのことを明確に書いてないためこのメールを読んだ社員にメールの内容が明確に伝わりません。
例えば、以下の『 』内のようなメールを送ればメールの内容が社員に明確に伝わります注2)。
『■社内技術論文の応募について
- 入社4年目~8年目までの中堅技術者を対象にして社内技術論文を募集します。過去に担当した業務に関する技術を対象とします。
■応募の方法
- 社内技術論文の提出を希望する社員は所属と氏名を書いたうえで「社内技術論文に応募します」と記載したメールを技術管理部の山田まで送ってください。
- 社内技術論文の提出を希望する社員に、社内技術論文のテーマの選定方法、執筆方法、提出期限などの詳細な作成規定をメールでお送りします。 』
注2):このメールは、下記の「6つのルールと18の書き方注3)」の中にある以下の4つの書き方を使って書いています。
- ①書き方6:かたまりに分けて書く
- ②書き方10:強調して書く
- ③書き方13:具体的な文を書く
- ④書き方14:意味が明確な文を書く
注3:「内容が明確に伝わる技術文書の書き方(その9) ~(その11)」を参照:3932
次回に続きます。
...
【関連文献紹介】森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
◆【特集】技術士第二次試験対策:技術士第二次試験に関する記事まとめページはこちら!口頭試験や論文対策などのポイントについての記事を紹介しています。