1. “内容が明確に伝わらない技術文書”を書くことで起こる重大なこと
内容が明確に伝わらない技術文書(わかりにくい技術文書のことです)を書くことで起こる重大なこととは、“無駄な時間を使うこと(時間の無駄遣い)”です。この理由を以下の3つの視点で解説します。
- ①技術文書を書く目的が達成できないこと
- ②読み手の仕事の時間を奪うこと
- ③仕事の手戻りがあること
2. 技術文書を書く目的が達成できないこと
技術文書を書く目的とは、技術文書の書き手からその読み手に内容を伝達することです注)。内容が明確に伝わらない技術文書を書けば技術文書を書く目的が達成できません。書き手から読み手に内容が伝達されていないからです。
つまり、内容が明確に伝わらない技術文書(技術文書を書く目的が未達成の技術文書)を書いている時間が無駄になります。これは、時間を無駄に使っていること(時間の無駄遣い)になります。
注):「“技術文書を書くこと”について考える(その2)」の記事を参照のこと
3. 読み手の仕事の時間を奪うこと
例えば、内容が明確に伝わらない業務報告書を仕事の依頼人(読み手)に渡したとします。これを読んだ読み手は、この業務報告書を理解するため何度もこれを読んだり、「この内容をどのように理解したらよいのだろうか」と考えたりします。あるいは、業務報告書の内容の確認のため、これを書いた人(書き手)に電話をしたりメールを送ったりするかもしれません。
これらのことは、読み手に無駄な時間を使わせていることになります。つまり、読み手の仕事の時間を奪っていることになります。
内容が明確に伝わる業務報告書を書けば、読み手には、このような時間の無駄遣いは発生しません。
4. 仕事の手戻りがあること
例えば、構造物の設計に関する設計条件の確認のためこれをまとめたものをこの仕事の依頼人(読み手)にメールで送ったとします。この設計条件の内容が明確に伝わらなかったら、読み手は、書き手に設計条件の内容を確認すると思います。
しかし、「たぶん、このような内容だろう」と理解して「この設計条件で設計を進めてください」という内容のメールを送ったとします。このとき、書き手が考えた設計条件の内容と読み手が理解した設計条件の内容が異なっていたらどうでしょうか。
この場合には、書き手は、間違った設計条件で設計することになります。その結果、構造物の設計の結果報告をしたとき「この設計条件は間違っています。やり直してください」と指摘されます。このように指摘されると間違った設計条件で仕事をしていた時間が無駄になります。仕事の手戻りなので時間の無駄遣いです。
5. 書き手にも読み手にも発生する時間の無駄遣い
このように、内容が明確に伝わらない技術文書を書くことで、この技術文書を書いた書き手にもこれを読んだ読み手にも時間の無駄遣いが発生します。内容が明確に伝わる技術文書を...