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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
ワークライフバランスを人材ポートフォリオで考える

 少子高齢化による人材不足から、女性の活用ニーズが高まっているようです。このあたりで、企業も個人も、ワークライフバランスについて、対応策を真剣に考える時期...

 少子高齢化による人材不足から、女性の活用ニーズが高まっているようです。このあたりで、企業も個人も、ワークライフバランスについて、対応策を真剣に考える時期...


問題増加ループを断ち切る問題解決の進め方とは

  問題解決の進め方を見ていると、その組織の文化風土が解ります。問題減少ループを回す組織への近道とは、なんでしょうか?今回は「問題増加ルー...

  問題解決の進め方を見ていると、その組織の文化風土が解ります。問題減少ループを回す組織への近道とは、なんでしょうか?今回は「問題増加ルー...


五感で伝える威力は絶大!(初級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その4)

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...


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

もっと見る
製造業におけるコミュニケーション講座

【目次】 1、製造業におけるコミュニケーション講座 (1) 良好なコミュニケーションをとるための3つのプロセス (2) リアクションの重要性...

【目次】 1、製造業におけるコミュニケーション講座 (1) 良好なコミュニケーションをとるための3つのプロセス (2) リアクションの重要性...


技術系以外の分野は、どう学べば良いか

      今回は、すそ野が広い技術系以外の分野をどう系統づけて学べば良いのかを解説します。     私は、技術士(情報工学部門)ということで...

      今回は、すそ野が広い技術系以外の分野をどう系統づけて学べば良いのかを解説します。     私は、技術士(情報工学部門)ということで...


QFD(品質機能展開)で人財開発施策を俯瞰

 QFD(Quality Function Deployment:品質機能展開)は、横軸にお客様の声を、縦軸に技術特性を記述したものです。しかし技術分野だ...

 QFD(Quality Function Deployment:品質機能展開)は、横軸にお客様の声を、縦軸に技術特性を記述したものです。しかし技術分野だ...