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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
「伝えたつもりの技術文書」を書く原因と書かないための方法(その2)

「伝えたつもりの技術文書」を書く原因と書かないための方法(その1)では、「伝えたつもりの技術文書」について解説しました。今回は、伝えたつもりの技術文書...

「伝えたつもりの技術文書」を書く原因と書かないための方法(その1)では、「伝えたつもりの技術文書」について解説しました。今回は、伝えたつもりの技術文書...


コミュニケーション 内容が明確に伝わる技術文書の書き方(その44)

  ◆コミュニケーションの違いについて 1.コミュニケーションの違いを明確にする 会話をすることも技術文書を書くこともコミュニケーショ...

  ◆コミュニケーションの違いについて 1.コミュニケーションの違いを明確にする 会話をすることも技術文書を書くこともコミュニケーショ...


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

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

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


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

もっと見る
製造業の価格交渉とは (タフネゴシエーターの名言)(その1)

        常々、私が思っていることですが、どんなに高く苦労してモノにした技術であっても、それを高く売る...

        常々、私が思っていることですが、どんなに高く苦労してモノにした技術であっても、それを高く売る...


【SDGs取組み事例】SDGs理念の下、企業と住民が地域課題解決に向け連携 太陽工業株式会社(長野県諏訪市)

♦「真善美」の考えが人を育む  【目次】 国内製造業のSDGs取り組み事例一覧へ戻る SDGs対応が取り引きや会社選...

♦「真善美」の考えが人を育む  【目次】 国内製造業のSDGs取り組み事例一覧へ戻る SDGs対応が取り引きや会社選...


自部門の数値把握:物流管理者の育て方(その2)

  ◆ 自部門の数値把握 現場に入りがちな管理者はそれが管理者として当たり前の仕事、かつ褒められてしかるべき行為だと考えている節があります。もし管...

  ◆ 自部門の数値把握 現場に入りがちな管理者はそれが管理者として当たり前の仕事、かつ褒められてしかるべき行為だと考えている節があります。もし管...