内容が明確に伝わる技術文書の書き方(その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パターン紹介します。   1. ...


課題解決に役立つ技術セミナーの選び方【前編】

  ◆ 課題解決の突破口!? 技術セミナーあ・ら・か・る・と  ものづくりに携わる技術者は、日々の業務の中で多くの未知の技術課題に直面し...

  ◆ 課題解決の突破口!? 技術セミナーあ・ら・か・る・と  ものづくりに携わる技術者は、日々の業務の中で多くの未知の技術課題に直面し...


技術者の能力資産をB/S(バランスシート)で評価する

1. 能力資産B/S評価の必要性  筆者は、10年以上前に書籍の中で、コンピテンシー(思考・行動特性)などの無形資産の定量的経済性評価法を試みました。不...

1. 能力資産B/S評価の必要性  筆者は、10年以上前に書籍の中で、コンピテンシー(思考・行動特性)などの無形資産の定量的経済性評価法を試みました。不...


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

もっと見る
加工現場のエースになるための7つの心構え

【目次】 1、加工現場のエースになるための心得とは  (1) 今ここにいる全員がいなくなっても、ものづくりができる準備をしている  (2) 次は...

【目次】 1、加工現場のエースになるための心得とは  (1) 今ここにいる全員がいなくなっても、ものづくりができる準備をしている  (2) 次は...


やろうと思っているけどできないことばかり、の克服(その4)

 前回は絞り込んでもなお、やりたいけどできないことに対して心理的抵抗を整理しました。ちょっと面倒だったと思いますけど、やりましたか?   や...

 前回は絞り込んでもなお、やりたいけどできないことに対して心理的抵抗を整理しました。ちょっと面倒だったと思いますけど、やりましたか?   や...


【SDGs取組み事例】事業性質にとらわれず、“SDGsに貢献可能なものは何か”を皆で考える エスティーティー株式会社(神奈川県秦野市)

目次 1.従業員の意識改革や職場環境の整備などに取り組む2.リサイクル装置設け、有機溶剤のリサイクルを開始3.塗装前処理工程を全自動化4.キャリアア...

目次 1.従業員の意識改革や職場環境の整備などに取り組む2.リサイクル装置設け、有機溶剤のリサイクルを開始3.塗装前処理工程を全自動化4.キャリアア...