内容が明確に伝わる技術文書の書き方(その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. 記事のテーマをかたまりに分けて書く  2018年4月4日に掲載した記事のテーマは、「かたまりに分けて書く(その2)」でした。この記事の中で、以...

1. 記事のテーマをかたまりに分けて書く  2018年4月4日に掲載した記事のテーマは、「かたまりに分けて書く(その2)」でした。この記事の中で、以...


OJCCとは(4)知識の育成 【快年童子の豆鉄砲】(その104)

  1. 一般社員育成の視点 前回の【快年童子の豆鉄砲】(その103)では、「企業が社員に求める能力10項目」(表84-1)の1番目「総...

  1. 一般社員育成の視点 前回の【快年童子の豆鉄砲】(その103)では、「企業が社員に求める能力10項目」(表84-1)の1番目「総...


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

もっと見る
QFD(品質機能展開)で人財開発施策を俯瞰

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

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


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

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

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


【SDGs取組み事例】SDGs理念の下、企業と住民が地域課題解決に向け連携

♦「真善美」の考えが人を育む 太陽工業株式会社(長野県諏訪市)  目次・SDGs対応が取り引きや会社選びの基準に・資格認定制度を設け社内...

♦「真善美」の考えが人を育む 太陽工業株式会社(長野県諏訪市)  目次・SDGs対応が取り引きや会社選びの基準に・資格認定制度を設け社内...