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

投稿日

技術文書

 

「6つのルールと18の書き方」に関し「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方」を以下に示します。「内容が明確に伝わる技術文書の書き方(その12)から(その18)」で「6つのルールと18の書き方」の具体的な使い方の一例を解説しました。今回は、わかりにくい書き方に気が付くを解説します。

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

人財教育

 

1.「わかりにくい(内容が明確に伝わらない)書き方」に気が付く

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

 

自分が読んでわかりにくい(内容が明確に伝わらない)と思うような技術文書は、読み手にとってもわかりにくいはずだ。そのため、自分が読んでわかりにくいと思う技術文書を書くべきではない。

 

このような認識を持つためには、自分が書いた技術文書を読み返したとき「この部分のこの書き方はわかりにくい(内容が明確に伝わらない)」ということに気が付く必要があります。例えば、「内容が明確に伝わる技術文書の書き方(その8)」の記事で書いたような文の羅列で書いてある内容を読んだとき、「文の羅列で書いてあるとわかりにくい(内容が明確に伝わらない)」と気が付くことです。

 

書いた内容を確認するだけは、「この書き方はわかりにくい(内容が明確に伝わらない)」ということに気が付きません。書いた内容の確認とともに「明確に伝わるかどうか」という確認も必要です。

 

つまり、技術文書を書いたら「自分が読み手だったらこの書き方でわかるか(内容が明確に伝わるか)」という視点での書き方の確認が必要です。

 

「この書き方はわかりにくい(内容が明確に伝わらない)」と気が付くためには、「どのような書き方をしたらわかりにくいか」という「わかりにくい」に対する判断基準が必要です。判断基準がないと、自分が書いた技術文書を読み返しても「わかりにくい(内容が明確に伝わらない)書き方」に気が付きません。

 

判断基準があることで、「わかりにくい(内容が明確に伝わらない)書き方」に気が付きます。

 

【参考】
今回の記事の内容に関係した記事を2018年1月10日に掲載しました。「『わかりにくい案内図』から学ぶこと」というテーマの記事です。「自分が...

技術文書

 

「6つのルールと18の書き方」に関し「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方」を以下に示します。「内容が明確に伝わる技術文書の書き方(その12)から(その18)」で「6つのルールと18の書き方」の具体的な使い方の一例を解説しました。今回は、わかりにくい書き方に気が付くを解説します。

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

人財教育

 

1.「わかりにくい(内容が明確に伝わらない)書き方」に気が付く

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

 

自分が読んでわかりにくい(内容が明確に伝わらない)と思うような技術文書は、読み手にとってもわかりにくいはずだ。そのため、自分が読んでわかりにくいと思う技術文書を書くべきではない。

 

このような認識を持つためには、自分が書いた技術文書を読み返したとき「この部分のこの書き方はわかりにくい(内容が明確に伝わらない)」ということに気が付く必要があります。例えば、「内容が明確に伝わる技術文書の書き方(その8)」の記事で書いたような文の羅列で書いてある内容を読んだとき、「文の羅列で書いてあるとわかりにくい(内容が明確に伝わらない)」と気が付くことです。

 

書いた内容を確認するだけは、「この書き方はわかりにくい(内容が明確に伝わらない)」ということに気が付きません。書いた内容の確認とともに「明確に伝わるかどうか」という確認も必要です。

 

つまり、技術文書を書いたら「自分が読み手だったらこの書き方でわかるか(内容が明確に伝わるか)」という視点での書き方の確認が必要です。

 

「この書き方はわかりにくい(内容が明確に伝わらない)」と気が付くためには、「どのような書き方をしたらわかりにくいか」という「わかりにくい」に対する判断基準が必要です。判断基準がないと、自分が書いた技術文書を読み返しても「わかりにくい(内容が明確に伝わらない)書き方」に気が付きません。

 

判断基準があることで、「わかりにくい(内容が明確に伝わらない)書き方」に気が付きます。

 

【参考】
今回の記事の内容に関係した記事を2018年1月10日に掲載しました。「『わかりにくい案内図』から学ぶこと」というテーマの記事です。「自分が読み手だったらこの書き方でわかるか(内容が明確に伝わるか)」という視点で案内板を見れば、「この案内板はわかりにくい(内容が明確に伝わらない)」ということに気が付くはずです。

 

次回に続きます。

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
「業務内容の詳細」の書き方のポイント(技術士第二次試験対策を例に)

 今回の記事は、「わかりやすい文書の書き方」の考え方を参考にしながら「業務内容の詳細」の書き方のポイントを解説します。   技術士第二次試験...

 今回の記事は、「わかりやすい文書の書き方」の考え方を参考にしながら「業務内容の詳細」の書き方のポイントを解説します。   技術士第二次試験...


“技術文書を書くこと”について考える(その1)

  1.技術者にとって「技術文書を書くこと」は重要 「技術者のための内容が“明確に”伝わる技術文書 注1)の書き...

  1.技術者にとって「技術文書を書くこと」は重要 「技術者のための内容が“明確に”伝わる技術文書 注1)の書き...


文書の書き方(文書の内容)をチェックするうえでのポイント

1. 文書の書き方(文書の内容)をチェックするうえでのポイント  「『君の書いた文書はわかりにくい』と言われないためにやるべきこと 」の記事の中で以...

1. 文書の書き方(文書の内容)をチェックするうえでのポイント  「『君の書いた文書はわかりにくい』と言われないためにやるべきこと 」の記事の中で以...


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

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

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

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


人財教育・人材育成、出来ることを行い、自分のキャパを広げる

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

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


【SDGs取り組み事例】環境対策を基盤に、働き甲斐と経済成長を実現 株式会社エフピコ

サステナブルな社会を目指した“人の輪づくり” 地球温暖化など環境問題が重要な社会課題として世界的に認識され、その保護気運の高...

サステナブルな社会を目指した“人の輪づくり” 地球温暖化など環境問題が重要な社会課題として世界的に認識され、その保護気運の高...