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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

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

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

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


部下を持つ人のための指導者のためのコーチングとは

1. コーチングとの出会い  日本の草分けの鈴木義幸氏から、筆者が3日間のロールプレイ中心のコーチング研修を受講したとき、リーダーにとってのコミュニケー...

1. コーチングとの出会い  日本の草分けの鈴木義幸氏から、筆者が3日間のロールプレイ中心のコーチング研修を受講したとき、リーダーにとってのコミュニケー...


やろうと思っているけど できないことばかりの克服【連載記事紹介】

  やろうと思っているけど できないことばかりのの克服 連載記事が無料でお読みいただけます!   ◆やろうと思っているけど できないこ...

  やろうと思っているけど できないことばかりのの克服 連載記事が無料でお読みいただけます!   ◆やろうと思っているけど できないこ...


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

もっと見る
人を誉める時は順番を考えよ -クリーン化診断の例を添えて-

 前回は人を誉める時のタイミングについてでした。今回はその順番についてお話します。 1.誉める順番を考える  現場に行って、「あれがいけない、これがい...

 前回は人を誉める時のタイミングについてでした。今回はその順番についてお話します。 1.誉める順番を考える  現場に行って、「あれがいけない、これがい...


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

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

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


人財教育・人材育成、具体的な目標と細かい仕事、計画の最も重要なことは仕事の細分化

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

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