内容が明確に伝わる技術文書の書き方(その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日

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
施策とは? ビジネスでのプロセスや混同しやすい言葉との違いについて

【目次】 国内最多のものづくりに関するセミナー掲載中! ものづくりドットコムでは、製造業に関するセミナーを常時2,000件...

【目次】 国内最多のものづくりに関するセミナー掲載中! ものづくりドットコムでは、製造業に関するセミナーを常時2,000件...


イキイキとした生産性の高い組織をつくる!「ポジティブ心理学」【完結編】

【ポジティブ心理学 連載目次】 1. イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】 2. イキイキ感をプラスにする!「ポジティブ...

【ポジティブ心理学 連載目次】 1. イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】 2. イキイキ感をプラスにする!「ポジティブ...


当事者意識や自覚を促すために必要な思考法とは

  【この連載の前回:相手の理解度を下げないやさしい伝え方とはへのリンク】 自覚や当事者意識は、問題が発生したとき「 私がそのモノゴトに...

  【この連載の前回:相手の理解度を下げないやさしい伝え方とはへのリンク】 自覚や当事者意識は、問題が発生したとき「 私がそのモノゴトに...


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

もっと見る
人財教育・人材育成、出来ることを行い、自分のキャパを広げる

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

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


【SDGs取り組み事例】ダイバーシティ経営で人的資源を最適化 有限会社川田製作所

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 【目次】   国内製造業のSDGs取り...

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 【目次】   国内製造業のSDGs取り...


職場の活動を人財育成と職場活性化の場にするには

 私が勤務していた会社では、「安全衛生推進パトロール」というものがありました。職場ごと、毎月当番制で、所属する職場を巡回し、安全面や3S、5Sの面でパトロ...

 私が勤務していた会社では、「安全衛生推進パトロール」というものがありました。職場ごと、毎月当番制で、所属する職場を巡回し、安全面や3S、5Sの面でパトロ...