内容が明確に伝わる技術文書の書き方(その1)

更新日

投稿日

技術文書

 

【この連載の前回:“技術文書を書くこと”について考える(その4)へのリンク】 

今回から、「内容が明確に伝わる技術文書」の書き方について解説します。

 

1.内容が明確に伝わる技術文書を書くための4項目

以下の4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

  • (1)重要なことを理解する
  • (2)書き方の技術を習得する
  • (3)必要なことを理解する
  • (4)日々のオンザジョブトレーニングを実践する

 

(1)重要なことを理解する

これは、内容が明確に伝わる技術文書を書くうえで重要なことを理解することです。重要なこととは、「技術文書を書く目的」や「“伝わる”と“明確に伝わる”の違い」などです。これらを理解することで、内容が明確に伝わる技術文書を書く必要性がわかります。これまでの4回で解説したことは「重要なことを理解する」に関する内容です。

 

(2)書き方の技術を習得する

これは、「内容が明確に伝わる技術文書の書き方の技術」を習得することです。書き方の技術とは、「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。これらは、内容が明確に伝わる技術文書の書き方の中心となる内容です。

 

(3)必要なことを理解する

これは、内容が明確に伝わる技術文書を書くうえで必要なことを理解することです。必要なこととは、「伝える内容を明確に理解していること」と「頭の中を整理すること」です。これらを理解することで、書き手が、伝える内容を理解しかつ整理できていることの重要性がわかります。

 

(4)日々のオンザジョブトレーニングを実践する

これは、継続学習(日々のオンザジョブトレーニング)をすることです。日々のオンザジョブトレーニングの実践で、内容が明確に伝わる技術文書の書き方が習得できます。また、書き方がレベルアップします。「継続は力なり」です。

 

内容が明確に伝わる技術文書を書くための4項目のうち、「重要なことを理解する」についてはこれまで4回にわたり解説しました。次回から「書き方の技術を習得する」、「必要なことを...

技術文書

 

【この連載の前回:“技術文書を書くこと”について考える(その4)へのリンク】 

今回から、「内容が明確に伝わる技術文書」の書き方について解説します。

 

1.内容が明確に伝わる技術文書を書くための4項目

以下の4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

  • (1)重要なことを理解する
  • (2)書き方の技術を習得する
  • (3)必要なことを理解する
  • (4)日々のオンザジョブトレーニングを実践する

 

(1)重要なことを理解する

これは、内容が明確に伝わる技術文書を書くうえで重要なことを理解することです。重要なこととは、「技術文書を書く目的」や「“伝わる”と“明確に伝わる”の違い」などです。これらを理解することで、内容が明確に伝わる技術文書を書く必要性がわかります。これまでの4回で解説したことは「重要なことを理解する」に関する内容です。

 

(2)書き方の技術を習得する

これは、「内容が明確に伝わる技術文書の書き方の技術」を習得することです。書き方の技術とは、「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。これらは、内容が明確に伝わる技術文書の書き方の中心となる内容です。

 

(3)必要なことを理解する

これは、内容が明確に伝わる技術文書を書くうえで必要なことを理解することです。必要なこととは、「伝える内容を明確に理解していること」と「頭の中を整理すること」です。これらを理解することで、書き手が、伝える内容を理解しかつ整理できていることの重要性がわかります。

 

(4)日々のオンザジョブトレーニングを実践する

これは、継続学習(日々のオンザジョブトレーニング)をすることです。日々のオンザジョブトレーニングの実践で、内容が明確に伝わる技術文書の書き方が習得できます。また、書き方がレベルアップします。「継続は力なり」です。

 

内容が明確に伝わる技術文書を書くための4項目のうち、「重要なことを理解する」についてはこれまで4回にわたり解説しました。次回から「書き方の技術を習得する」、「必要なことを理解する」および「日々のオンザジョブトレーニングを実践する」について解説します。

 

【参考文献】

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

 

関連解説記事「書くべきことを自分の頭の中ではっきりさせる」 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
会議での説明(その1) 内容が明確に伝わる技術文書の書き方(その45)

  ◆会議でうまく説明する方法(その1) 「内容が明確に伝わる技術文書の書き方(その44)」の中で「会話をすることも技術文書を書くことも...

  ◆会議でうまく説明する方法(その1) 「内容が明確に伝わる技術文書の書き方(その44)」の中で「会話をすることも技術文書を書くことも...


“施策”と“方策”の違いを考える

   前回の記事では、技術士第二次試験での問題(技術的体験論文)に関する内容を書きました。今回も、技術士第二次試験での問題に関する内容を書きます。  ...

   前回の記事では、技術士第二次試験での問題(技術的体験論文)に関する内容を書きました。今回も、技術士第二次試験での問題に関する内容を書きます。  ...


わかりやすい文書を書くうえで最も重要なこととは

 日々、仕事で様々な文書を書いていると思います。例えば、業務報告書、打合せ資料、技術提案書、社内稟議書、メールなどです。    今回は、これらの文書を...

 日々、仕事で様々な文書を書いていると思います。例えば、業務報告書、打合せ資料、技術提案書、社内稟議書、メールなどです。    今回は、これらの文書を...


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

もっと見る
人財教育・人材育成、謙虚と卑屈、「そもそも無理だった」という理由

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

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


部下の育成とは:物流管理者の育て方(その3)

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...


提案制度の考察、参加しやすいルールとは、継続できるしくみとは

      1. 参加しやすいルールとは メーカーでは全従業員が毎月何かしらの提案を行っている会社が多いと思います。メーカーで...

      1. 参加しやすいルールとは メーカーでは全従業員が毎月何かしらの提案を行っている会社が多いと思います。メーカーで...