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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
「出会って30秒で仲間のように話せるラポール」を身に着ければ安泰!(初級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その2)

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


技術系ビジネスリーダーの養成 (その1)

【目次】 【技術系ビジネスリーダー養成 連載目次】 1、技術者の2つのキャリアパス 2、海外市場で事業成果を出せる技術系ビジ...

【目次】 【技術系ビジネスリーダー養成 連載目次】 1、技術者の2つのキャリアパス 2、海外市場で事業成果を出せる技術系ビジ...


ワークライフバランスを人材ポートフォリオで考える

 少子高齢化による人材不足から、女性の活用ニーズが高まっているようです。このあたりで、企業も個人も、ワークライフバランスについて、対応策を真剣に考える時期...

 少子高齢化による人材不足から、女性の活用ニーズが高まっているようです。このあたりで、企業も個人も、ワークライフバランスについて、対応策を真剣に考える時期...


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

もっと見る
『わかりにくい案内図』から学ぶこと

1. 案内図の表示が上下逆さま  弊社は埼玉県所沢市にあります。昨年の夏頃、所沢駅西口の駅前の交差点に写真①のような案内板が設置されました。この案内...

1. 案内図の表示が上下逆さま  弊社は埼玉県所沢市にあります。昨年の夏頃、所沢駅西口の駅前の交差点に写真①のような案内板が設置されました。この案内...


人財教育・人材育成、期待や願望ではなく成果を出すための行動

【目次】 1. 期待と願望、期待や願望ではなく成果を出すための行動 将来や周りの人に対して期待や願望を持つことはよくあります。その...

【目次】 1. 期待と願望、期待や願望ではなく成果を出すための行動 将来や周りの人に対して期待や願望を持つことはよくあります。その...


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

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

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