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

投稿日

技術文書

 

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

「内容が明確に伝わる技術文書の書き方(その4)から(その6)」で、具体的な事例を使って「第1原則:書き手と読み手の違いを認識する」に関することを解説しました。書き手と読み手の違いを認識して書くことが、内容が明確に伝わる技術文書を書くうえでのスタートだからです。

 

今回は、過去3回とは違った視点で書き方の第1原則について解説します。“ことわざ”という視点です。書き方の第1原則を理解するうえで参考になる“ことわざ”があります。そこで、“ことわざ”と書き方の第1原則との関係を解説します。

 

1.我が身をつねって人の痛さを知れ

「内容が明確に伝わる技術文書の書き方の3原則」での第1原則は、「書き手と読み手の違いを認識する」です。

 

技術文書

 

これは、「書き手と読み手の違いを認識したうえで、読み手のことを考えて技術文書を書く」、すなわち、「読み手の立場に立って技術文書を書く」という考え方です。

 

ここで参考になるのが、「我が身をつねって人の痛さを知れ」という“ことわざ”です。「我が身をつねって人の痛さを知れ」とは、自分の身をつねったその痛みから、人の痛みを知るということで、他人の痛みや苦しみを自分自身の痛みに置き換え相手を思いやることが大事だという教えです。

 

これを、技術文書を書く場合に当てはめると、「自分が書いた技術文書を読み手の立場に立って読んでみると、わかりにくい(内容が明確に伝わらない)と思う書き方がわかる。自分が読み手だったらこのような書き方をしないでほしいと思う。読み手のことを思いやり、わかりやすい(内容が明確に伝わる)書き方で書くことが大事」という解釈になります。

 

自分が書いた技術文書を、「書いた内容を確認する」のような書き手の立場に立って読んでいると、わかりにくい(内容が明確に伝わらない)と思う書き方を見つけることはできません。「自分が読み手だったら、この書き方で内容が明確に伝わるか」という読み手の立場に立って読むことでわかりにくい(内容が明確に伝わらない)と思う書き方を見つけることができます。

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
技術者能力の評価基準 -成果を出し続ける技術者の要件-

1. 能力の評価基準策定の背景  前回、個人能力の市場価値評価、キャリアチェンジがあることは当たり前を解説しました。今回は、成果を出し続ける技術者の要件...

1. 能力の評価基準策定の背景  前回、個人能力の市場価値評価、キャリアチェンジがあることは当たり前を解説しました。今回は、成果を出し続ける技術者の要件...


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

  2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方(その1)」の中で「内容が明確に伝わる技術文書を書くための4項目」と...

  2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方(その1)」の中で「内容が明確に伝わる技術文書を書くための4項目」と...


「お客様のことを考えて文書を書く」とは

 わかりやすい文書を書くうえで最も重要なことは、「書き手と読み手の違いを認識したうえで、読み手の立場に立って文書を書くこと」です。これは、これまでに掲載さ...

 わかりやすい文書を書くうえで最も重要なことは、「書き手と読み手の違いを認識したうえで、読み手の立場に立って文書を書くこと」です。これは、これまでに掲載さ...


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

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

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

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


リーダーに必要な素養:マネジメント能力とは

 【目次】 ◆ マネジメントと問い合わせ対応は異なります  1. 問い合わせの事例  2. オペレーションの一部になっているのはマネジメントでは...

 【目次】 ◆ マネジメントと問い合わせ対応は異なります  1. 問い合わせの事例  2. オペレーションの一部になっているのはマネジメントでは...


【インタビュー】ダイバーシティは企業存続に必要不可欠!  取り組みに懸ける思いと国内企業の現状

パナソニック コネクト株式会社取締役 執行役員 山口有希子氏  ヤンマーホールディングス株式会社取締役CSO 長田志織氏  ...

パナソニック コネクト株式会社取締役 執行役員 山口有希子氏  ヤンマーホールディングス株式会社取締役CSO 長田志織氏  ...