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

投稿日

技術文書

 

「6つのルールと18の書き方」に関し「6つのルール」および「18の書き方」の概要について解説してきました。「6つのルールと18の書き方」を以下に示します。今回は「6つのルールと18の書き方」を「わかりにくい」に対する判断基準にするを解説します。

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

人財教育

 

1.「6つのルールと18の書き方」を判断基準にする

「内容が明確に伝わる技術文書の書き方(その20)」の記事の中で以下のことを書きました。

 

「この書き方はわかりにくい(内容が明確に伝わらない)」と気が付くためには、「どのような書き方をしたらわかりにくいか」という「わかりにくい」に対する判断基準が必要です。

 

これまで、「6つのルールと18の書き方」について解説しました。この「6つのルールと18の書き方」が「わかりにくい」に対する判断基準になります。

 

「6つのルールと18の書き方」を使って書けば内容が明確に伝わる技術文書(わかりやすい技術文書)を書くことができます。逆に言うと、「6つのルールと18の書き方」に反した書き方で書けば内容が明確に伝わらない(わかりにくい)技術文書になります。つまり、「6つのルールと18の書き方」が「わかりにくい」に対する判断基準になります。例えば、以下のようなことです。

 

  • 内容の要点を冒頭に書いてないのでわかりにくい。⇒「書き方1:要点を冒頭に書く」に反している。
  • 文の羅列で書いてあるのでわかりにくい。    ⇒「書き方6:かたまりに分けて書く」に反している。
  • 写真がないのでわかりにくい          ⇒「書き方9:写真や図を入れて書く」に反している。
  • 具体的な文を書いてないのでわかりにくい。   ⇒「書き方13:具体的な文を書く」に反している。

 

また、「6つのルールと18の書き方」を使って、「わかりにくい(内容が明確に伝わらない)書き方」を「わかりやすい(内容が明確に伝わる)書き方」に修正することができます。例えば、以下のようことです。

 

  • 内容の要点が文章の最後に書いてあるのでわかりにくい。⇒「書き方1:要点を冒頭に書く」を使って修正しよう。
  • この箇所は文の羅列で書いてあるのでわかりにくい。  ⇒「書き方6:かたまりに分けて書く」を使って修正しよう。
  • 「○○駅では、4月から△△線と□□線との乗り換えが同一ホームでできるようになった。その結果、鉄道利用者の利便性が向上した」と書いてあるのでわかりにくい。⇒「書き方13:具体的な文を書く」を使って修正しよう。

 

この...

技術文書

 

「6つのルールと18の書き方」に関し「6つのルール」および「18の書き方」の概要について解説してきました。「6つのルールと18の書き方」を以下に示します。今回は「6つのルールと18の書き方」を「わかりにくい」に対する判断基準にするを解説します。

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

人財教育

 

1.「6つのルールと18の書き方」を判断基準にする

「内容が明確に伝わる技術文書の書き方(その20)」の記事の中で以下のことを書きました。

 

「この書き方はわかりにくい(内容が明確に伝わらない)」と気が付くためには、「どのような書き方をしたらわかりにくいか」という「わかりにくい」に対する判断基準が必要です。

 

これまで、「6つのルールと18の書き方」について解説しました。この「6つのルールと18の書き方」が「わかりにくい」に対する判断基準になります。

 

「6つのルールと18の書き方」を使って書けば内容が明確に伝わる技術文書(わかりやすい技術文書)を書くことができます。逆に言うと、「6つのルールと18の書き方」に反した書き方で書けば内容が明確に伝わらない(わかりにくい)技術文書になります。つまり、「6つのルールと18の書き方」が「わかりにくい」に対する判断基準になります。例えば、以下のようなことです。

 

  • 内容の要点を冒頭に書いてないのでわかりにくい。⇒「書き方1:要点を冒頭に書く」に反している。
  • 文の羅列で書いてあるのでわかりにくい。    ⇒「書き方6:かたまりに分けて書く」に反している。
  • 写真がないのでわかりにくい          ⇒「書き方9:写真や図を入れて書く」に反している。
  • 具体的な文を書いてないのでわかりにくい。   ⇒「書き方13:具体的な文を書く」に反している。

 

また、「6つのルールと18の書き方」を使って、「わかりにくい(内容が明確に伝わらない)書き方」を「わかりやすい(内容が明確に伝わる)書き方」に修正することができます。例えば、以下のようことです。

 

  • 内容の要点が文章の最後に書いてあるのでわかりにくい。⇒「書き方1:要点を冒頭に書く」を使って修正しよう。
  • この箇所は文の羅列で書いてあるのでわかりにくい。  ⇒「書き方6:かたまりに分けて書く」を使って修正しよう。
  • 「○○駅では、4月から△△線と□□線との乗り換えが同一ホームでできるようになった。その結果、鉄道利用者の利便性が向上した」と書いてあるのでわかりにくい。⇒「書き方13:具体的な文を書く」を使って修正しよう。

 

このように、「6つのルールと18の書き方」は、「わかりにくい」に対する判断基準になります。また、「わかりにくい」を「わかりやすい」に修正する方法として使えます。

 

次回に続きます。

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
なりきり会議とは、会議室は、笑顔と笑い声、そしてアイデアが広がる!

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

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


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

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

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


多品種少量生産時代の「プロ人材」の役割とは

◆ 製造業の品質改善事例、対策の進め方    多品種少量生産工場において、生産技術者、品質管理自術者と呼ばれる人材が必要性を増しています。そ...

◆ 製造業の品質改善事例、対策の進め方    多品種少量生産工場において、生産技術者、品質管理自術者と呼ばれる人材が必要性を増しています。そ...


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

もっと見る
改善活動の共通言語

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

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


人財教育・人材育成、小さな成果と人の頑張り

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

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


引き継ぎ資料で押さえるポイントとは

  四半期末や年度末、退職のタイミングで自身の業務を次の担当者に引き継ぐことは誰しも経験があるのではないでしょうか。今回は業務引き継ぎ資料...

  四半期末や年度末、退職のタイミングで自身の業務を次の担当者に引き継ぐことは誰しも経験があるのではないでしょうか。今回は業務引き継ぎ資料...