必要なことを理解する 内容が明確に伝わる技術文書の書き方(その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日

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
教育システムの設計:多能工・技能工人材の育成【連載記事紹介】

  どうしたら効果のある教育訓練が実施できるでしょうか?   現場の即戦力となる人材、世の中で通用する人材を育てるための教育...

  どうしたら効果のある教育訓練が実施できるでしょうか?   現場の即戦力となる人材、世の中で通用する人材を育てるための教育...


文書の内容の伝わり方 内容が明確に伝わる技術文書の書き方(その28)

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!   今回は、「ルール6:明確に伝わる文...

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!   今回は、「ルール6:明確に伝わる文...


「相手の立場に立って考える」こと

 2018年4月10日に掲載された記事のテーマは「『お客様のことを考えて文書を書く』とは」でした。この記事の冒頭で、「わかりやすい文書を書くうえで最も重要...

 2018年4月10日に掲載された記事のテーマは「『お客様のことを考えて文書を書く』とは」でした。この記事の冒頭で、「わかりやすい文書を書くうえで最も重要...


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

もっと見る
改善活動の共通言語

 コスト削減、品質改善、業務改善などの改善活動を行う時、アクションに携わるスタッフが改善の為の『共通言語』を身につけているかどうかで効率や効果が変わってき...

 コスト削減、品質改善、業務改善などの改善活動を行う時、アクションに携わるスタッフが改善の為の『共通言語』を身につけているかどうかで効率や効果が変わってき...


名選手、名監督にあらず:物流管理者の育て方(その1)

  ◆ 名選手、名監督にあらず 昔から「名選手、名監督にあらず」ということが言われています。プロ野球でもよくあることです。一流選手が監督...

  ◆ 名選手、名監督にあらず 昔から「名選手、名監督にあらず」ということが言われています。プロ野球でもよくあることです。一流選手が監督...


人財教育・人材育成、正しいこと、正しいことにとらわれ過ぎないことも大事

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

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