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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
人事評価者研修 教育研修の進め方(その5)

【教育研修の進め方 連載目次】 1.  教育制度を見直す必要 2.  ジョブスキル教育 3.  階層別教育 4....

【教育研修の進め方 連載目次】 1.  教育制度を見直す必要 2.  ジョブスキル教育 3.  階層別教育 4....


文書の書き方(文書の内容)をチェックするうえでのポイント

1. 文書の書き方(文書の内容)をチェックするうえでのポイント  「『君の書いた文書はわかりにくい』と言われないためにやるべきこと 」の記事の中で以...

1. 文書の書き方(文書の内容)をチェックするうえでのポイント  「『君の書いた文書はわかりにくい』と言われないためにやるべきこと 」の記事の中で以...


緊張をほぐして、説明力と説得力を高められる簡単な方法とは

  人前で何かを説明したり説得をするシーンは、ビジネスパーソンにとっては日常茶飯事です。しかし、大なり小なりその前には「緊張」が伴うのでは...

  人前で何かを説明したり説得をするシーンは、ビジネスパーソンにとっては日常茶飯事です。しかし、大なり小なりその前には「緊張」が伴うのでは...


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

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

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

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


  物流作業者変更時の留意点とは:物流4M管理の重要性(その2)

  ◆ 物流作業者変更時の留意点  人に関しては毎年個人単位にどのような分野を教えていくのかを明確にしていきましょう。そして習熟計画を作...

  ◆ 物流作業者変更時の留意点  人に関しては毎年個人単位にどのような分野を教えていくのかを明確にしていきましょう。そして習熟計画を作...


人財教育・人材育成、負け試合、失敗とわかっても投げやりにならずに取り組むこと

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

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