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

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
わかりやすい文書を書くうえで最も重要なこととは

 日々、仕事で様々な文書を書いていると思います。例えば、業務報告書、打合せ資料、技術提案書、社内稟議書、メールなどです。    今回は、これらの文書を...

 日々、仕事で様々な文書を書いていると思います。例えば、業務報告書、打合せ資料、技術提案書、社内稟議書、メールなどです。    今回は、これらの文書を...


『記憶術』で記憶力の活性化、思い出す力を鍛えよう

  今回は、リスキリングを助ける『記憶術』についておはなしします。あなたの記憶力が活性化されます。   1. 記憶力は誰もが...

  今回は、リスキリングを助ける『記憶術』についておはなしします。あなたの記憶力が活性化されます。   1. 記憶力は誰もが...


相手が自ら動く、たった1行の魔法の言葉(中級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その5)

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...


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

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

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

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


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

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

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


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

 やろうと思っているけどできないことでモヤモヤしている気持ち。そんな気持ちを克服する方法の3回目です。    これまで紹介したのは次のステッ...

 やろうと思っているけどできないことでモヤモヤしている気持ち。そんな気持ちを克服する方法の3回目です。    これまで紹介したのは次のステッ...