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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
問題解決をあきらめない力、問題解決レジリエンスとは

  問題が起こるたびに、面倒くささや喪失感が沸き起こり、根本的原因を追及しないまま、それを繰り返す。これが続くと、問題解決力そのものが低下...

  問題が起こるたびに、面倒くささや喪失感が沸き起こり、根本的原因を追及しないまま、それを繰り返す。これが続くと、問題解決力そのものが低下...


「君の書いた文書はわかりにくい」と言われないためにやるべきこと

1. セミナーでの回答  2年前から、製造業の技術者などの方を対象にしたセミナーで講師を務めています。セミナーのテーマは、「わかりやすい文書の書き方...

1. セミナーでの回答  2年前から、製造業の技術者などの方を対象にしたセミナーで講師を務めています。セミナーのテーマは、「わかりやすい文書の書き方...


OJTでは、教える側に対する教育が大切 効果的な教育研修の進め方(その2)

 OJT(On the Job Training)とは、仕事を通じて社員の能力開発を図るものですから、人材育成の中で、最も大切であり効果をあげやすいもので...

 OJT(On the Job Training)とは、仕事を通じて社員の能力開発を図るものですから、人材育成の中で、最も大切であり効果をあげやすいもので...


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

もっと見る
「やろうと思っているけどできないことばかり」の克服(その6)

  「やろうと思っているけどできないことばかり、の克服」も今回で6回目ですが、今回が最終回です。   前回は、習慣化のための...

  「やろうと思っているけどできないことばかり、の克服」も今回で6回目ですが、今回が最終回です。   前回は、習慣化のための...


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

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

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


【SDGs取り組み事例】多文化共生と女性活躍推進に注力 株式会社ヤマヲ(東京都立川市)

今年、創立70周年を迎え、麺(めん)類、パスタ類の弁当や惣菜などを製造する株式会社ヤマヲ(代表取締役社長 岡部栄一氏)では、多文化共生や女性活躍推進を...

今年、創立70周年を迎え、麺(めん)類、パスタ類の弁当や惣菜などを製造する株式会社ヤマヲ(代表取締役社長 岡部栄一氏)では、多文化共生や女性活躍推進を...