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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
コンピテンシー・マネジメントシステムとは

1. コンピテンシーとは  多くの企業では、近年、コンピテンシー採用やコンピテンシーによる実績評価を実施しています。そこで、人財開発領域で非常に重要なキ...

1. コンピテンシーとは  多くの企業では、近年、コンピテンシー採用やコンピテンシーによる実績評価を実施しています。そこで、人財開発領域で非常に重要なキ...


研究開発に威力を発揮するモチベーション理論

1.モチベ―ションをどう捉えるか  かつて、バブルの全盛期に、新卒を採用するためにいろいろな特典を用意していたことを覚えているでしょうか。車を買ってあげ...

1.モチベ―ションをどう捉えるか  かつて、バブルの全盛期に、新卒を採用するためにいろいろな特典を用意していたことを覚えているでしょうか。車を買ってあげ...


人財教育、当事者意識と能力を備え、周囲を感動させるリーダーとは

【目次】 先日、25名の問題解決ファシリテーターが巣立ちました。全員、自信溢れる言葉や姿勢で修了証を手にしていました。その姿を見送る...

【目次】 先日、25名の問題解決ファシリテーターが巣立ちました。全員、自信溢れる言葉や姿勢で修了証を手にしていました。その姿を見送る...


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

もっと見る
‐能力開発のシステム創り 製品・技術開発力強化策の事例(その43)

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その42に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確...

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その42に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確...


 PDCA サイクルとシステム手帳

  今回は、「スケジュールやタスクをどうやって管理しているのか」という話題です。僕が「フランクリン・プランナーを使っている」と言うと、皆が「え...

  今回は、「スケジュールやタスクをどうやって管理しているのか」という話題です。僕が「フランクリン・プランナーを使っている」と言うと、皆が「え...


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

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

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