「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その1)」で,「マンガでわかる技術文書の書き方」を購入していただき「内容が明確に伝わる技術文書の書き方」を勉強する方法を紹介しました。
今回から,「マンガでわかる技術文書の書き方」を参考にしたブログを掲載します。
弊社では,「わかりやすい=内容が明確に伝わる」と定義しています。したがって,「わかりやすい技術文書=内容が明確に伝わる技術文書」です。内容が明確に伝わる技術文書を書くための考え方が「内容が明確に伝わる技術文書の書き方の3原則」です。
=
書き方の第1原則は,内容が明確に伝わる技術文書を書くうえで重要な原則です。ここで,書き方の第1原則を理解するうえで参考になる“ことわざ”があります。
■我が身をつねって人の痛さを知れ
「内容が明確に伝わる技術文書の書き方の3原則」での第1原則は,「書き手と読み手の違いを認識する」です。
これは,「書き手と読み手の違いを認識したうえで,読み手のことを考えて技術文書を書く」,すなわち,「読み手の立場に立って技術文書を書く」という考え方です。
ここで参考になるのが,「我が身をつねって人の痛さを知れ」という“ことわざ”です。「我が身をつねって人の痛さを知れ」とは,自分の身をつねったその痛みから,人の痛みを知るということで,他人の痛みや苦しみを自分自身の痛みに置き換え相手を思いやることが大事だという教えです。
これを,技術文書を書く場合に当てはめると,「自分が書いた技術文書を読み手の立場に立って読んでみると,わかりにくい(内容が明確に伝わらない)と思う書き方がわかる。自分が読み手だったらこのような書き方をしないでほしいと思う。読み手のことを思いやり,わかりやすい(内容が明確に伝わる)書き方で書くことが大事」という解釈になります。
自分が書いた技術文書を,「書いた内容を確認する」のような書き手の立場に立って読んでいると,わかりにくい(内容が明確に伝わらない)と思う書き方を見つけることはできません。
ー
「自分が読み手だったら,この書き方で内容が明確に伝わるか」という読み手の立場に立って読むことで,わかりにくい(内容が明確に伝わらない)と思う書き方を見つけることができます。
次回に続きます。
【参考図書】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日