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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
技術系ビジネスリーダーの養成 (その3)

【目次】 【技術系ビジネスリーダー養成 連載目次】 1、技術者の2つのキャリアパス 2、海外市場で事業成果を出せる技術系ビジ...

【目次】 【技術系ビジネスリーダー養成 連載目次】 1、技術者の2つのキャリアパス 2、海外市場で事業成果を出せる技術系ビジ...


自分の仕事に余裕を作るには

1. 「捨てる」スキル   ◆商品開発に「捨てる」はもう常識    今回は、日々の仕事と商品仕様における「捨てる」スキルについ...

1. 「捨てる」スキル   ◆商品開発に「捨てる」はもう常識    今回は、日々の仕事と商品仕様における「捨てる」スキルについ...


『継続は力なり』で文書を書く力がレベルアップする

 今回の記事のキーワードは“継続は力なり”です。“継続は力なり”とは、「地道な努力を続けていけばやがてその積み重ねが力となる」のような意味です。   ...

 今回の記事のキーワードは“継続は力なり”です。“継続は力なり”とは、「地道な努力を続けていけばやがてその積み重ねが力となる」のような意味です。   ...


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

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

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

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


技術系リーダーとして身に付けておくべきスキルとは

        企業の成長のためには、従来の事業の延長線上に留まることなく、積極的に新製品や新規事業の創出、...

        企業の成長のためには、従来の事業の延長線上に留まることなく、積極的に新製品や新規事業の創出、...


「やろうと思っているけどできないことばかり」の克服(その6)

  「やろうと思っているけどできないことばかり、の克服」も今回で6回目ですが、今回が最終回です。   前回は、習慣化のための...

  「やろうと思っているけどできないことばかり、の克服」も今回で6回目ですが、今回が最終回です。   前回は、習慣化のための...