内容が明確に伝わる技術文書の書き方(その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.人が育てば相互にベクトルが合い、企業の体質が強くなる 2.仕事を覚えたい気持ちにさせる 3.品質...

【ものづくり現場の人財育成 連載目次】 1.人が育てば相互にベクトルが合い、企業の体質が強くなる 2.仕事を覚えたい気持ちにさせる 3.品質...


わかりやすい文書を書くうえで最も重要なこととは

 日々、仕事で様々な文書を書いていると思います。例えば、業務報告書、打合せ資料、技術提案書、社内稟議書、メールなどです。    今回は、これらの文書を...

 日々、仕事で様々な文書を書いていると思います。例えば、業務報告書、打合せ資料、技術提案書、社内稟議書、メールなどです。    今回は、これらの文書を...


研究開発に威力を発揮するモチベーション理論

1.モチベ―ションをどう捉えるか  かつて、バブルの全盛期に、新卒を採用するためにいろいろな特典を用意していたことを覚えているでしょうか。車を買ってあげ...

1.モチベ―ションをどう捉えるか  かつて、バブルの全盛期に、新卒を採用するためにいろいろな特典を用意していたことを覚えているでしょうか。車を買ってあげ...


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

もっと見る
人財教育・人材育成、得意・不得意の見極め

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

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


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

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

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


コストを明確にして、評価できる人材を育成する(その1)

 コストを明確にして、評価できる人材を育成する過程を、次のS社を例に、二回に分けて解説します。   1.S社の背景  S社は、印刷機械の受注の窓...

 コストを明確にして、評価できる人材を育成する過程を、次のS社を例に、二回に分けて解説します。   1.S社の背景  S社は、印刷機械の受注の窓...