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

1. わかりやすい文書を書くうえでのポイント    「デザイン・ルールズ:伊達千代&内藤タカヒコ著(エムディエヌコーポレーション)」の中で著...

1. わかりやすい文書を書くうえでのポイント    「デザイン・ルールズ:伊達千代&内藤タカヒコ著(エムディエヌコーポレーション)」の中で著...


キャリア選択シートで過去・現在・未来を見通す 技術者のキャリア整理法(その3)

 前回の、技術者のキャリア整理法(その2)ライフキャリアの視点に続いて、今回は、キャリア選択シートで過去・現在・未来を見通すです。元サッカー選手の中田英寿...

 前回の、技術者のキャリア整理法(その2)ライフキャリアの視点に続いて、今回は、キャリア選択シートで過去・現在・未来を見通すです。元サッカー選手の中田英寿...


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

もっと見る
品質管理教育の重要ポイント

 教えを請うなら実績のある人が好ましいと多くの人は思うでしょう。しかし実績のある人(成果を出している人)が必ずしも教え上手では無いと言うことがあります。今...

 教えを請うなら実績のある人が好ましいと多くの人は思うでしょう。しかし実績のある人(成果を出している人)が必ずしも教え上手では無いと言うことがあります。今...


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

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

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


製造業向けローコードの活用!次世代型MESで製造業DXによる変革を

今カンファレンスで、ものづくり現場のDXを力強く推進する最新ソリューションのセッションが行われた中、特にものづくりドットコムが注目する株式会社TーPr...

今カンファレンスで、ものづくり現場のDXを力強く推進する最新ソリューションのセッションが行われた中、特にものづくりドットコムが注目する株式会社TーPr...