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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
スピーチの悩みを心理学で解決、スマートトークのコツとは

【目次】 先日、お客様と話をしているとき、こんなことを話されていました。その方は、長年の努力の末に手掛けた、新製品の発表イベントに立...

【目次】 先日、お客様と話をしているとき、こんなことを話されていました。その方は、長年の努力の末に手掛けた、新製品の発表イベントに立...


伝える内容の理解度 内容が明確に伝わる技術文書の書き方(その32)

     今回は、「内容が明確に伝わる技術文書の書き方(その31)」の続きです。今回も、「伝える内容を明確に理解している...

     今回は、「内容が明確に伝わる技術文書の書き方(その31)」の続きです。今回も、「伝える内容を明確に理解している...


書くうえでのポイント かたまりに分けて書く (その1)

1. わかりやすい文書を書くうえでのポイント    「デザイン・ルールズ:伊達千代&内藤タカヒコ著(エムディエヌコーポレーション)」の中で著...

1. わかりやすい文書を書くうえでのポイント    「デザイン・ルールズ:伊達千代&内藤タカヒコ著(エムディエヌコーポレーション)」の中で著...


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

もっと見る
人財教育・人材育成、固執、本人が自覚することが固執から解放される一番の方法

【目次】 1. 固執、本人が自覚することが固執から解放される一番の方法 「なんとか自力で解決しよう」とやっきになっても、焦ってばか...

【目次】 1. 固執、本人が自覚することが固執から解放される一番の方法 「なんとか自力で解決しよう」とやっきになっても、焦ってばか...


【SDGs取り組み事例】環境対策を基盤に、働き甲斐と経済成長を実現 株式会社エフピコ

サステナブルな社会を目指した“人の輪づくり” 地球温暖化など環境問題が重要な社会課題として世界的に認識され、その保護気運の高...

サステナブルな社会を目指した“人の輪づくり” 地球温暖化など環境問題が重要な社会課題として世界的に認識され、その保護気運の高...


製造業向けローコードの活用!次世代型MESで製造業DXによる変革を

今カンファレンスで、ものづくり現場のDXを力強く推進する最新ソリューションのセッションが行われた中、特にものづくりドットコムが注目する株式会社TーPr...

今カンファレンスで、ものづくり現場のDXを力強く推進する最新ソリューションのセッションが行われた中、特にものづくりドットコムが注目する株式会社TーPr...