内容が明確に伝わる技術文書の書き方(その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日

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
新人教育はどのように実施したらよいか

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

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


部下の成長を促す方法とは

  書籍を読んでいたら『仕事に満足していない人は7割もいる』と書いてあり、私は「えっ、本当に?」と驚きを隠せませんでした。人の心は、浮き沈...

  書籍を読んでいたら『仕事に満足していない人は7割もいる』と書いてあり、私は「えっ、本当に?」と驚きを隠せませんでした。人の心は、浮き沈...


教育制度を見直す必要 教育研修の進め方(その1)

【教育研修の進め方 連載目次】 1.  教育制度を見直す必要 2.  ジョブスキル教育 3.  階層別教育 4....

【教育研修の進め方 連載目次】 1.  教育制度を見直す必要 2.  ジョブスキル教育 3.  階層別教育 4....


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

もっと見る
部下の育成とは:物流管理者の育て方(その3)

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...


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

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

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


リーダーに必要な素養:マネジメント能力とは

 【目次】 ◆ マネジメントと問い合わせ対応は異なります  1. 問い合わせの事例  2. オペレーションの一部になっているのはマネジメントでは...

 【目次】 ◆ マネジメントと問い合わせ対応は異なります  1. 問い合わせの事例  2. オペレーションの一部になっているのはマネジメントでは...