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

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
相手の理解度を下げないやさしい伝え方とは

  【この連載の前回:あなたの「 やる気スイッチ 」はソコにある!へのリンク】   ある方から、「WEB研修に参加する機会が...

  【この連載の前回:あなたの「 やる気スイッチ 」はソコにある!へのリンク】   ある方から、「WEB研修に参加する機会が...


アクティブラーニング、文科省が推進する理由をわかりやすく解説

  第4次産業革命が進行中の現代、AI・IoT・DX技術などの発達で、何を創るかのフロントランナーの時代へとパラダイムシフトしています。企...

  第4次産業革命が進行中の現代、AI・IoT・DX技術などの発達で、何を創るかのフロントランナーの時代へとパラダイムシフトしています。企...


「文書を書くことができるが、わかりやすい文書を書くことができない」について

  1. IT分野の技術者の方々について  「森谷さん、IT分野の仕事に従事する技術者の中で文書を書くことができない技術者は多いですよ・・・」 ...

  1. IT分野の技術者の方々について  「森谷さん、IT分野の仕事に従事する技術者の中で文書を書くことができない技術者は多いですよ・・・」 ...


「人財教育」の活用事例

もっと見る
部下の育成とは:物流管理者の育て方(その3)

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...


改善活動の共通言語

 コスト削減、品質改善、業務改善などの改善活動を行う時、アクションに携わるスタッフが改善の為の『共通言語』を身につけているかどうかで効率や効果が変わってき...

 コスト削減、品質改善、業務改善などの改善活動を行う時、アクションに携わるスタッフが改善の為の『共通言語』を身につけているかどうかで効率や効果が変わってき...


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

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

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