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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
あなたの説得力と説明力が高まる伝わる話し方とは

  私は、仕事柄、多くの人前で話をする機会があります。きっと、あなたにも、部下や後輩の前で何かを話したり、プレゼンテーションなどのシーンで...

  私は、仕事柄、多くの人前で話をする機会があります。きっと、あなたにも、部下や後輩の前で何かを話したり、プレゼンテーションなどのシーンで...


【快年童子の豆鉄砲】(その111)OJCCとは(11)数理統計能力

  1. 数理統計手法の活用能力 今回は「企業が社員に求める能力10項目」(表84-1)にもあり、現在の仕事を向上させるための3つの&l...

  1. 数理統計手法の活用能力 今回は「企業が社員に求める能力10項目」(表84-1)にもあり、現在の仕事を向上させるための3つの&l...


階層別教育 教育研修の進め方(その3)

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

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


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

もっと見る
【SDGs取り組み事例】インクルージョンされた職場環境において、新しい価値を生み出し続ける ソニー・太陽株式会社(大分県速見郡日出町)

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...


スモールスタートで始めるDX ~ PDCAサイクル高速化で品質・生産性向上

  デジタル技術で現場リーダーの身近な課題を解決 高崎ものづくり技術研究所 濱田 金男氏 【目次】 【アーカイブ動画のご...

  デジタル技術で現場リーダーの身近な課題を解決 高崎ものづくり技術研究所 濱田 金男氏 【目次】 【アーカイブ動画のご...


人財教育・人材育成、こだわりと責任範囲

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. こだわり「別の方法がある」と考えることも大事 ...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. こだわり「別の方法がある」と考えることも大事 ...