内容が明確に伝わる技術文書の書き方(その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. 能力の市場価値算出の背景  よく、ヘッドハンティング会社や人材紹介会社のホームページで、「あなたの市場価値はいくら?」というようなキャッチフレーズ...

1. 能力の市場価値算出の背景  よく、ヘッドハンティング会社や人材紹介会社のホームページで、「あなたの市場価値はいくら?」というようなキャッチフレーズ...


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

もっと見る
仕事とは、仕事の準備、仕事の重点、仕事の継続

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 仕事とは、仕事の準備 仕事に限らず何事にも準...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 仕事とは、仕事の準備 仕事に限らず何事にも準...


【SDGs取組み事例】知識ゼロから出発。計400トンのCO<sub>2</sub>削減に成功 来ハトメ工業株式会社

2010(平成22)年にエコアクション21認証を取得し、ゼロの状態から脱炭素化に向けた取り組みを始めた来ハトメ工業株式会社(埼玉県八潮市)。電力使用量...

2010(平成22)年にエコアクション21認証を取得し、ゼロの状態から脱炭素化に向けた取り組みを始めた来ハトメ工業株式会社(埼玉県八潮市)。電力使用量...


引き継ぎ資料で押さえるポイントとは

  四半期末や年度末、退職のタイミングで自身の業務を次の担当者に引き継ぐことは誰しも経験があるのではないでしょうか。今回は業務引き継ぎ資料...

  四半期末や年度末、退職のタイミングで自身の業務を次の担当者に引き継ぐことは誰しも経験があるのではないでしょうか。今回は業務引き継ぎ資料...