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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
エンジニアが出版で失敗する原因と対策

        皆さんは論文や報告書を書いた経験がありますか? 今回は、仕事で報告書を書ているエンジニアが本の出版で失敗する原因と成功の対策について...

        皆さんは論文や報告書を書いた経験がありますか? 今回は、仕事で報告書を書ているエンジニアが本の出版で失敗する原因と成功の対策について...


レジリエンスとは【連載記事紹介】知って得する人的資源マネジメント 

  【目次】 ◆ レジリエンスとは レジリエンスは逆境から這い上がるときに必要な特別な力というのではなく、社会生活を送る上...

  【目次】 ◆ レジリエンスとは レジリエンスは逆境から這い上がるときに必要な特別な力というのではなく、社会生活を送る上...


“問題”と“課題”の違いを考える

   1. “問題”と“課題”の意味の違いとは  仕事で、“問題”や“課題”という単語(言葉)を使うことがあると思います。テレビやラジオのニュース...

   1. “問題”と“課題”の意味の違いとは  仕事で、“問題”や“課題”という単語(言葉)を使うことがあると思います。テレビやラジオのニュース...


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

もっと見る
「話し方」で解決!職場で仕事を押し付けられていたMさんの実例

  1. 仕事を押し付けられて残業続き  Mさんは技術系の会社に勤める元気のいい女性です。一見、話し方に問題はなさそうに見えるのですが、...

  1. 仕事を押し付けられて残業続き  Mさんは技術系の会社に勤める元気のいい女性です。一見、話し方に問題はなさそうに見えるのですが、...


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

    やろうと思っているけどできないことでモヤモヤしている気持ち。そんな気持ちを克服する方法の3回目です。   これまで...

    やろうと思っているけどできないことでモヤモヤしている気持ち。そんな気持ちを克服する方法の3回目です。   これまで...


人財教育・人材育成、自分自身の感覚を研ぎ澄まして雰囲気言葉に要注意

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...