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

投稿日

技術文書

 

1.「内容が明確に伝わる技術文書の書き方の3原則」を判断基準にする

「内容が明確に伝わる技術文書の書き方(その21)」では、「6つのルールと18の書き方」を「わかりにくい」に対する判断基準にすることを解説しました。

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

人財教育

 

「内容が明確に伝わる技術文書の書き方(その2)」で解説した「内容が明確に伝わる技術文書の書き方の3原則」の中での「第2原則:内容が明確に伝わる構成を考える」も「わかりにくい」に対する判断基準になります。

 

技術文書

 

技術文書の構成は技術文書の骨組みです。技術文書の骨組みがしっかりしていないと内容が明確に伝わりません。

「内容が明確に伝わる技術文書の書き方(その13)」の中で【パターンⅠ】として以下のメールの内容を書きました。

 

【メールのパターンⅠ】

昨日A社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。

「A社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する」とのことだった。
「今週の木曜日の17時までに、効果と削減額をA社の山田部長までメールで送って欲しい」との指示があった。
〇月〇日の10時からA社で行う次回の打ち合わせでA社の結論を話す。

以 上

 

このメールには構成がありません。このような書き方では内容が明確に伝わりません。「内容が明確に伝わる技術文書の書き方(その13)」の中では、「書き方の第2原則」に基づきメールの構成を考えた【パターンⅡ】のメールの内容を書きました。

 

【メールのパターンⅡ】

昨日A社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。

1.打ち合わせでの結論

〇〇管理システムの導入に関する結論は出なかった。A社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する。

2.打ち合わせでの指示事項

今週の木曜日の17時までに、効果と削減額をA社の山田部長までメールで送る。

3.今後の予定

〇月〇日の10時からA社で行う次回の打ち合わせでA社の結論を話す。

以 上

 

このメールでは、「1.打ち合わせでの結論」、「2.打ち合わせでの指示事項」および「3.今後の予定」を項目とした構成を考えて書きました。このように書くことで内容が明確に伝わります。

 

このように、技術文書の構成の有無で「この書き方はわかりにくい(内容が明確に伝わらない)」と判断することができます。すなわち、「書き方の第2原則:内容が明確に伝わる構成を考える」も「わかりにくい」の判断基準になります。結論として、「6つのルールと18の書き方」と「書き方の第2原則:内容が明確に伝...

技術文書

 

1.「内容が明確に伝わる技術文書の書き方の3原則」を判断基準にする

「内容が明確に伝わる技術文書の書き方(その21)」では、「6つのルールと18の書き方」を「わかりにくい」に対する判断基準にすることを解説しました。

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

人財教育

 

「内容が明確に伝わる技術文書の書き方(その2)」で解説した「内容が明確に伝わる技術文書の書き方の3原則」の中での「第2原則:内容が明確に伝わる構成を考える」も「わかりにくい」に対する判断基準になります。

 

技術文書

 

技術文書の構成は技術文書の骨組みです。技術文書の骨組みがしっかりしていないと内容が明確に伝わりません。

「内容が明確に伝わる技術文書の書き方(その13)」の中で【パターンⅠ】として以下のメールの内容を書きました。

 

【メールのパターンⅠ】

昨日A社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。

「A社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する」とのことだった。
「今週の木曜日の17時までに、効果と削減額をA社の山田部長までメールで送って欲しい」との指示があった。
〇月〇日の10時からA社で行う次回の打ち合わせでA社の結論を話す。

以 上

 

このメールには構成がありません。このような書き方では内容が明確に伝わりません。「内容が明確に伝わる技術文書の書き方(その13)」の中では、「書き方の第2原則」に基づきメールの構成を考えた【パターンⅡ】のメールの内容を書きました。

 

【メールのパターンⅡ】

昨日A社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。

1.打ち合わせでの結論

〇〇管理システムの導入に関する結論は出なかった。A社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する。

2.打ち合わせでの指示事項

今週の木曜日の17時までに、効果と削減額をA社の山田部長までメールで送る。

3.今後の予定

〇月〇日の10時からA社で行う次回の打ち合わせでA社の結論を話す。

以 上

 

このメールでは、「1.打ち合わせでの結論」、「2.打ち合わせでの指示事項」および「3.今後の予定」を項目とした構成を考えて書きました。このように書くことで内容が明確に伝わります。

 

このように、技術文書の構成の有無で「この書き方はわかりにくい(内容が明確に伝わらない)」と判断することができます。すなわち、「書き方の第2原則:内容が明確に伝わる構成を考える」も「わかりにくい」の判断基準になります。結論として、「6つのルールと18の書き方」と「書き方の第2原則:内容が明確に伝わる構成を考える」が「わかりにくい」に対する判断基準になります。

 

前回と今回で解説したように、「わかりにくい(内容が明確に伝わらない)」に気が付き、それを、「わかりやすい(内容が明確に伝わる)」に修正することで内容が明確に伝わる技術文書を書くことができます。

 

次回に続きます。

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
レジリエンスとは【連載記事紹介】知って得する人的資源マネジメント 

  【目次】 ◆ レジリエンスとは レジリエンスは逆境から這い上がるときに必要な特別な力というのではなく、社会生活を送る上...

  【目次】 ◆ レジリエンスとは レジリエンスは逆境から這い上がるときに必要な特別な力というのではなく、社会生活を送る上...


イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】

【ポジティブ心理学 連載目次】 1. イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】 2. イキイキ感をプラスにする!「ポジティブ心理...

【ポジティブ心理学 連載目次】 1. イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】 2. イキイキ感をプラスにする!「ポジティブ心理...


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

  2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方(その1)」の中で「内容が明確に伝わる技術文書を書くための4項目」と...

  2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方(その1)」の中で「内容が明確に伝わる技術文書を書くための4項目」と...


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

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

 やろうと思っているけどできないことってありますね。ぼくもやろうと思っていることがたくさんあるのにできないことばかりです。コーチングでもよくあるテーマです...

 やろうと思っているけどできないことってありますね。ぼくもやろうと思っていることがたくさんあるのにできないことばかりです。コーチングでもよくあるテーマです...


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

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

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


【SDGs取り組み事例】自然と社会との共生を目指して 日本テクノ株式会社

従業員主体で環境保護、サステナビリティへの取り組み 日本テクノ株式会社(東京都新宿区) SDGs(持続可能な開発目標)の観点からみても重要な取り組...

従業員主体で環境保護、サステナビリティへの取り組み 日本テクノ株式会社(東京都新宿区) SDGs(持続可能な開発目標)の観点からみても重要な取り組...