必要なことを理解する 内容が明確に伝わる技術文書の書き方(その30)

投稿日

技術文書

 

1.内容が明確に伝わる技術文書を書くための4項目

内容が明確に伝わる技術文書の書き方(その1)」で、内容が明確に伝わる技術文書を書くための4項目を解説しました。以下の4項目です。

 

  • ①重要なことを理解する
  • ②書き方の技術を習得する
  • ③必要なことを理解する
  • ④日々のオンザジョブトレーニングを実践する

 

今回は、「③必要なことを理解する」について解説します。「必要なこと」とは、「伝える内容を明確に理解していること」と「頭の中を整理すること」の2項目です。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その29)へのリンク】 

 

2.伝える内容を明確に理解していること

伝える内容を明確に理解していることで、内容が明確に伝わる技術文書を書くことができます。逆を言えば、「伝える内容が理解したつもり」では、内容が明確に伝わる技術文書を書くことができません。

 

「理解したつもり」とは、伝える内容を自分は理解していると思っていても実際は理解していないことです。「理解したつもり」については、2018年3月13日に掲載した「“理解したつもり”から“理解した”へ」をテーマにした記事を参考にしてください。この記事の中で「伝える力:池上彰著」からの引用として以下のことを書きました。

 

“「伝える」ために大事なこと。それはまず、自分自身がしっかり理解することです。自分がわかっていないと、相手に伝わるはずがないからです”

 

この内容は、内容が明確に伝わる技術文書を書くうえで重要なことです。理解したつもりのレベルで書いた技術文書では内容が明確に伝わりません。「“理解したつもり”から“理解した”へ」で内容が明確に伝わる技術文書を書くことができます。

 

3.頭の中を整理すること

頭の中を整理して書くことも内容が明確に伝わる技術文書を書くための条件です。

 

「今回の報告書には、これを書こう、これを書かなきゃ、あれを書こう、あれも書かなきゃ・・・」のような頭の中が未整理の状態で書くと内容が明確に伝わらない報告書を書いてしまいます。例えば、頭の中が未整理の状態で書くと、「内容が明確に伝わる技術文書の書き方(その8)」で書いたように「車の主な種類」を文の羅列で書いてしまいます。

このように、「必要なことを理解する」ということも内容が明確に伝わる技術文書を書くうえで重要なことです。

 

技術文書

 

次回に続きます。

【参考文...

技術文書

 

1.内容が明確に伝わる技術文書を書くための4項目

内容が明確に伝わる技術文書の書き方(その1)」で、内容が明確に伝わる技術文書を書くための4項目を解説しました。以下の4項目です。

 

  • ①重要なことを理解する
  • ②書き方の技術を習得する
  • ③必要なことを理解する
  • ④日々のオンザジョブトレーニングを実践する

 

今回は、「③必要なことを理解する」について解説します。「必要なこと」とは、「伝える内容を明確に理解していること」と「頭の中を整理すること」の2項目です。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その29)へのリンク】 

 

2.伝える内容を明確に理解していること

伝える内容を明確に理解していることで、内容が明確に伝わる技術文書を書くことができます。逆を言えば、「伝える内容が理解したつもり」では、内容が明確に伝わる技術文書を書くことができません。

 

「理解したつもり」とは、伝える内容を自分は理解していると思っていても実際は理解していないことです。「理解したつもり」については、2018年3月13日に掲載した「“理解したつもり”から“理解した”へ」をテーマにした記事を参考にしてください。この記事の中で「伝える力:池上彰著」からの引用として以下のことを書きました。

 

“「伝える」ために大事なこと。それはまず、自分自身がしっかり理解することです。自分がわかっていないと、相手に伝わるはずがないからです”

 

この内容は、内容が明確に伝わる技術文書を書くうえで重要なことです。理解したつもりのレベルで書いた技術文書では内容が明確に伝わりません。「“理解したつもり”から“理解した”へ」で内容が明確に伝わる技術文書を書くことができます。

 

3.頭の中を整理すること

頭の中を整理して書くことも内容が明確に伝わる技術文書を書くための条件です。

 

「今回の報告書には、これを書こう、これを書かなきゃ、あれを書こう、あれも書かなきゃ・・・」のような頭の中が未整理の状態で書くと内容が明確に伝わらない報告書を書いてしまいます。例えば、頭の中が未整理の状態で書くと、「内容が明確に伝わる技術文書の書き方(その8)」で書いたように「車の主な種類」を文の羅列で書いてしまいます。

このように、「必要なことを理解する」ということも内容が明確に伝わる技術文書を書くうえで重要なことです。

 

技術文書

 

次回に続きます。

【参考文献】

森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日

◆【特集】 連載記事紹介連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!

 

関連解説記事「相手の立場に立って考える」こと 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
未来人材ビジョンで求められる起業家マインドを持ち据えた人物とは、

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

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


社内研修での講師の心得、資料を丁寧に伝えるだけなら講師は要らない

  社内研修を企画・開催した時「研修効果がわかりにくい」「講師と受講者に距離感が出てしまっている」「教育担当、講師のリソース不足を感じる」...

  社内研修を企画・開催した時「研修効果がわかりにくい」「講師と受講者に距離感が出てしまっている」「教育担当、講師のリソース不足を感じる」...


問題解決の基本とアイデア発想 【厳選記事紹介】「ひらめき」の時とは

  ◆問題解決の基本とアイデア発想 「問題についてジックリ考える」ということ。問題を強烈に意識して考えれば、それは問題意識となり脳の中に...

  ◆問題解決の基本とアイデア発想 「問題についてジックリ考える」ということ。問題を強烈に意識して考えれば、それは問題意識となり脳の中に...


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

もっと見る
「話し方」で解決!職場で仕事を押し付けられていたMさんの実例

  1. 仕事を押し付けられて残業続き  Mさんは技術系の会社に勤める元気のいい女性です。一見、話し方に問題はなさそうに見えるのですが、...

  1. 仕事を押し付けられて残業続き  Mさんは技術系の会社に勤める元気のいい女性です。一見、話し方に問題はなさそうに見えるのですが、...


人財教育・人材育成、 周囲の反応、強みと弱み、自己評価と周囲の評価が一致していない時

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! 1. 周囲の反応、自分のことは自分が一番見えていない 自...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! 1. 周囲の反応、自分のことは自分が一番見えていない 自...


‐能力開発のシステム創り 製品・技術開発力強化策の事例(その48)

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その47に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確にす...

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その47に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確にす...