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

投稿日

技術文書

 

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

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

 

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

 

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

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

 

技術文書

 

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

 

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

 

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

 

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

 

次回に続きます。

 

【参考文献】

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

 

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

 

この記事の著者

森谷 仁

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

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


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

もっと見る
製造業の人材育成・多能工化:新人教育の進め方とは

 新入社員は、新人研修、OJTによる現場指導など、教育訓練を実施して、早く即戦力として仕事を任せられるようにしなければなりません。しかし、教育はなかなかう...

 新入社員は、新人研修、OJTによる現場指導など、教育訓練を実施して、早く即戦力として仕事を任せられるようにしなければなりません。しかし、教育はなかなかう...


OJCCとは(1) 【快年童子の豆鉄砲】(その101)

  1. はじめに 表2-1の喫緊の課題の9番目「離職率が高い」は、折角の縁があって入社した社員が、短期間で離職するという中小企業にとっ...

  1. はじめに 表2-1の喫緊の課題の9番目「離職率が高い」は、折角の縁があって入社した社員が、短期間で離職するという中小企業にとっ...


社内研修での講師の心得、資料を丁寧に伝えるだけなら講師は要らない

  社内研修を企画・開催した時「研修効果がわかりにくい」「講師と受講者に距離感が出てしまっている」「教育担当、講師のリソース不足を感じる」...

  社内研修を企画・開催した時「研修効果がわかりにくい」「講師と受講者に距離感が出てしまっている」「教育担当、講師のリソース不足を感じる」...


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

もっと見る
  物流作業者変更時の留意点とは:物流4M管理の重要性(その2)

  ◆ 物流作業者変更時の留意点  人に関しては毎年個人単位にどのような分野を教えていくのかを明確にしていきましょう。そして習熟計画を作...

  ◆ 物流作業者変更時の留意点  人に関しては毎年個人単位にどのような分野を教えていくのかを明確にしていきましょう。そして習熟計画を作...


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

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

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


人財教育・人材育成、解決すべき問題と避けるべき問題とは

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

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