内容が明確に伝わる技術文書の書き方(その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. “わかりにくい説明資料”を渡される  弊社ではA社の複合機をリースしています。以前、A社の複合機をリースする会社(B社とします)の営業マン(C...

1. “わかりにくい説明資料”を渡される  弊社ではA社の複合機をリースしています。以前、A社の複合機をリースする会社(B社とします)の営業マン(C...


「提案弱者」は「伝える」が分かれば躍進できる!

 上司、同僚、部下、家族のため、お客様のために、自分の考えや思いを「伝えたい」方はたくさんいます。  しかし、ほとんどの人は伝えようと努力しても、驚...

 上司、同僚、部下、家族のため、お客様のために、自分の考えや思いを「伝えたい」方はたくさんいます。  しかし、ほとんどの人は伝えようと努力しても、驚...


【快年童子の豆鉄砲】(その111)OJCCとは(11)数理統計能力

  1. 数理統計手法の活用能力 今回は「企業が社員に求める能力10項目」(表84-1)にもあり、現在の仕事を向上させるための3つの&l...

  1. 数理統計手法の活用能力 今回は「企業が社員に求める能力10項目」(表84-1)にもあり、現在の仕事を向上させるための3つの&l...


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

もっと見る
【SDGs取り組み事例】自然と社会との共生を目指して 日本テクノ株式会社

従業員主体で環境保護、サステナビリティへの取り組み SDGs(持続可能な開発目標)の観点からみても重要な取り組みとして注目されている「エコチューニン...

従業員主体で環境保護、サステナビリティへの取り組み SDGs(持続可能な開発目標)の観点からみても重要な取り組みとして注目されている「エコチューニン...


人財教育・人材育成、ただ頑張るだけでは仕事ではありません。結果を意識した行動が取れますか?

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

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


結果につなげる言葉と行動、自身の行動目標を決めること

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

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