内容が明確に伝わる技術文書の書き方(その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.仕事を楽しくやる努力が必要   亡くなられた大学の先生が、「悔いの無い人生を送るには、楽しい仕事を見つけるのではなく、与えられた仕事の中に楽しさを見...

1.仕事を楽しくやる努力が必要   亡くなられた大学の先生が、「悔いの無い人生を送るには、楽しい仕事を見つけるのではなく、与えられた仕事の中に楽しさを見...


OJCCとは(2) 【快年童子の豆鉄砲】(その102)

    ◆企業が社員に求める能力10項目 1. 「OJCC」の特徴 この「OJCC」には下記2つの特徴があります。 1)「企...

    ◆企業が社員に求める能力10項目 1. 「OJCC」の特徴 この「OJCC」には下記2つの特徴があります。 1)「企...


コンピテンシー・マネジメントシステムとは

1. コンピテンシーとは  多くの企業では、近年、コンピテンシー採用やコンピテンシーによる実績評価を実施しています。そこで、人財開発領域で非常に重要なキ...

1. コンピテンシーとは  多くの企業では、近年、コンピテンシー採用やコンピテンシーによる実績評価を実施しています。そこで、人財開発領域で非常に重要なキ...


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

もっと見る
コンプライアンス意識を持とう:職場のマネジメント

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...


加工現場のエースになるための7つの心構え

【目次】 1、加工現場のエースになるための心得とは  (1) 今ここにいる全員がいなくなっても、ものづくりができる準備をしている  (2) 次は...

【目次】 1、加工現場のエースになるための心得とは  (1) 今ここにいる全員がいなくなっても、ものづくりができる準備をしている  (2) 次は...


【SDGs取り組み事例】インクルージョンされた職場環境において、新しい価値を生み出し続ける ソニー・太陽株式会社(大分県速見郡日出町)

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...