内容が伝わり難い技術文書を書くことで起こる重大なこと

投稿日

  内容が伝わり難い技術文書を書くことで起こる重大なこと
【目次】

    1. “内容が明確に伝わらない技術文書”を書くことで起こる重大なこと

    内容が明確に伝わらない技術文書(わかりにくい技術文書のことです)を書くことで起こる重大なこととは、“無駄な時間を使うこと(時間の無駄遣い)”です。この理由を以下の3つの視点で解説します。

    • ①技術文書を書く目的が達成できないこと
    • ②読み手の仕事の時間を奪うこと
    • ③仕事の手戻りがあること

     

    2. 技術文書を書く目的が達成できないこと

    技術文書を書く目的とは、技術文書の書き手からその読み手に内容を伝達することです注)。内容が明確に伝わらない技術文書を書けば技術文書を書く目的が達成できません。書き手から読み手に内容が伝達されていないからです。

     

    つまり、内容が明確に伝わらない技術文書(技術文書を書く目的が未達成の技術文書)を書いている時間が無駄になります。これは、時間を無駄に使っていること(時間の無駄遣い)になります。

    注):“技術文書を書くこと”について考える(その2)」の記事を参照のこと

     

    3. 読み手の仕事の時間を奪うこと

    例えば、内容が明確に伝わらない業務報告書を仕事の依頼人(読み手)に渡したとします。これを読んだ読み手は、この業務報告書を理解するため何度もこれを読んだり、「この内容をどのように理解したらよいのだろうか」と考えたりします。あるいは、業務報告書の内容の確認のため、これを書いた人(書き手)に電話をしたりメールを送ったりするかもしれません。

     

    これらのことは、読み手に無駄な時間を使わせていることになります。つまり、読み手の仕事の時間を奪っていることになります。

     

    内容が明確に伝わる業務報告書を書けば、読み手には、このような時間の無駄遣いは発生しません。

     

    4. 仕事の手戻りがあること

    例えば、構造物の設計に関する設計条件の確認のためこれをまとめたものをこの仕事の依頼人(読み手)にメールで送ったとします。この設計条件の内容が明確に伝わらなかったら、読み手は、書き手に設計条件の内容を確認すると思います。

     

    しかし、「たぶん、このような内容だろう」と理解して「この設計条件で設計を進めてください」という内容のメールを送ったとします。このとき、書き手が考えた設計条件の内容と読み手が理解した設計条件の内容が異なっていたらどうでしょうか。

     

    この場合には、書き手は、間違った設計条件で設計することになります。その結果、構造物の設計の結果報告をしたとき「この設計条件は間違っています。やり直してください」と指摘されます。このように指摘されると間違った設計条件で仕事をしていた時間が無駄になります。仕事の手戻りなので時間の無駄遣いです。

     

    5. 書き手にも読み手にも発生する時間の無駄遣い

    このように、内容が明確に伝わらない技術文書を書くことで、この技術文書を書いた書き手にもこれを読んだ読み手にも時間の無駄遣いが発生します。内容が明確に伝わる技術文書を...

      内容が伝わり難い技術文書を書くことで起こる重大なこと
    【目次】

      1. “内容が明確に伝わらない技術文書”を書くことで起こる重大なこと

      内容が明確に伝わらない技術文書(わかりにくい技術文書のことです)を書くことで起こる重大なこととは、“無駄な時間を使うこと(時間の無駄遣い)”です。この理由を以下の3つの視点で解説します。

      • ①技術文書を書く目的が達成できないこと
      • ②読み手の仕事の時間を奪うこと
      • ③仕事の手戻りがあること

       

      2. 技術文書を書く目的が達成できないこと

      技術文書を書く目的とは、技術文書の書き手からその読み手に内容を伝達することです注)。内容が明確に伝わらない技術文書を書けば技術文書を書く目的が達成できません。書き手から読み手に内容が伝達されていないからです。

       

      つまり、内容が明確に伝わらない技術文書(技術文書を書く目的が未達成の技術文書)を書いている時間が無駄になります。これは、時間を無駄に使っていること(時間の無駄遣い)になります。

      注):“技術文書を書くこと”について考える(その2)」の記事を参照のこと

       

      3. 読み手の仕事の時間を奪うこと

      例えば、内容が明確に伝わらない業務報告書を仕事の依頼人(読み手)に渡したとします。これを読んだ読み手は、この業務報告書を理解するため何度もこれを読んだり、「この内容をどのように理解したらよいのだろうか」と考えたりします。あるいは、業務報告書の内容の確認のため、これを書いた人(書き手)に電話をしたりメールを送ったりするかもしれません。

       

      これらのことは、読み手に無駄な時間を使わせていることになります。つまり、読み手の仕事の時間を奪っていることになります。

       

      内容が明確に伝わる業務報告書を書けば、読み手には、このような時間の無駄遣いは発生しません。

       

      4. 仕事の手戻りがあること

      例えば、構造物の設計に関する設計条件の確認のためこれをまとめたものをこの仕事の依頼人(読み手)にメールで送ったとします。この設計条件の内容が明確に伝わらなかったら、読み手は、書き手に設計条件の内容を確認すると思います。

       

      しかし、「たぶん、このような内容だろう」と理解して「この設計条件で設計を進めてください」という内容のメールを送ったとします。このとき、書き手が考えた設計条件の内容と読み手が理解した設計条件の内容が異なっていたらどうでしょうか。

       

      この場合には、書き手は、間違った設計条件で設計することになります。その結果、構造物の設計の結果報告をしたとき「この設計条件は間違っています。やり直してください」と指摘されます。このように指摘されると間違った設計条件で仕事をしていた時間が無駄になります。仕事の手戻りなので時間の無駄遣いです。

       

      5. 書き手にも読み手にも発生する時間の無駄遣い

      このように、内容が明確に伝わらない技術文書を書くことで、この技術文書を書いた書き手にもこれを読んだ読み手にも時間の無駄遣いが発生します。内容が明確に伝わる技術文書を書けばこのような時間の無駄遣いは発生しません。

       

      「内容が明確に伝わらない技術文書を書くことで、書き手に、時間の無駄遣いが発生する」、「内容が明確に伝わらない技術文書を書けば、読み手に、無駄な時間を使わせる(読み手に迷惑がかかる)」ということを認識して技術文書を書く必要があります。書き手も読み手も仕事の時間を無駄なく使うためです。

       

      このように考えると、内容が明確に伝わる技術文書を書くことの重要性が理解できると思います。

       

      【関連文献紹介】森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日

      ◆関連解説記事:実践!技術マネジメント:7つのプロセスと35のチェックポイント

       

      特集】技術士第二次試験対策:技術士第二次試験に関する記事まとめページはこちら!口頭試験や論文対策などのポイントについての記事を紹介しています。

       

       

         続きを読むには・・・


      この記事の著者

      森谷 仁

      「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!

      「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!


      「人財教育・育成」の他のキーワード解説記事

      もっと見る
      話の範囲を意識すると、話はわかりやすくなる。

        1. 人によって、話の範囲=スコープに違いがある あなたは、下記のパターンA・B どちらの説明を好みますか? 内容は例として、昨夜食...

        1. 人によって、話の範囲=スコープに違いがある あなたは、下記のパターンA・B どちらの説明を好みますか? 内容は例として、昨夜食...


      記憶力を向上させるにはイメージ力と連想力を高める

        歳と共に衰える 記憶力 。若くても 「 なかなか覚えられない 」 といった悩み。ときおり、 ため息と一緒にでるあきらめ感。よしっ! と...

        歳と共に衰える 記憶力 。若くても 「 なかなか覚えられない 」 といった悩み。ときおり、 ため息と一緒にでるあきらめ感。よしっ! と...


      寄り添うリーダーシップ、支援上手でお互いの価値観を認めるリーダーとは

         【目次】 新人のモチベーションアップと維持を支援するためには、どのようなアプローチが必要なのでしょうか?ヒン...

         【目次】 新人のモチベーションアップと維持を支援するためには、どのようなアプローチが必要なのでしょうか?ヒン...


      「人財教育・育成」の活用事例

      もっと見る
      「やろうと思っているけどできないことばかり」の克服(その5)

          前回は、やる気を起こすにはとにかく行動することが大切で、行動を起こすための工夫をいくつか紹介しました。やろうと思ってで...

          前回は、やる気を起こすにはとにかく行動することが大切で、行動を起こすための工夫をいくつか紹介しました。やろうと思ってで...


      金型・機械加工メーカー:人材タイプ別、やる気のコントロール方法

         今回は、金型・機械加工メーカー業界の皆さんの関心が高い、人材、従業員のタイプ別に見た、やる気のコントロール方法について解説します。そもそ...

         今回は、金型・機械加工メーカー業界の皆さんの関心が高い、人材、従業員のタイプ別に見た、やる気のコントロール方法について解説します。そもそ...


      人財教育・人材育成、対極の考察

      【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...

      【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...