内容が明確に伝わる技術文書の書き方(その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、海外出向先での悪魔のサイクル   海外に出向して現地人との関係が何故「悪魔のサイクル」になってしまうのでしょう?まずこの点について説明します。  ...


問題解決が進まないチームには、同じような「クセ」がある

  問題の再発防止策を立てたはずなのに、また再発してしまう。これは、本当に辛いモノです。ありとあらゆる手を尽くしたにもかかわらず、再発して...

  問題の再発防止策を立てたはずなのに、また再発してしまう。これは、本当に辛いモノです。ありとあらゆる手を尽くしたにもかかわらず、再発して...


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

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

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

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


製造業の価格交渉とは (タフネゴシエーターの名言)(その1)

        常々、私が思っていることですが、どんなに高く苦労してモノにした技術であっても、それを高く売る...

        常々、私が思っていることですが、どんなに高く苦労してモノにした技術であっても、それを高く売る...


 PDCA サイクルとシステム手帳

   今回は、「スケジュールやタスクをどうやって管理しているのか」という話題です。僕が「フランクリン・プランナーを使っている」と言うと、皆が「...

   今回は、「スケジュールやタスクをどうやって管理しているのか」という話題です。僕が「フランクリン・プランナーを使っている」と言うと、皆が「...