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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
内容が明確に伝わる技術文書の書き方(その10)

  今回は、「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説します。「6つのルールと18の書...

  今回は、「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説します。「6つのルールと18の書...


問題解決の上手い人は、問題を分ける・細分化する

  問題の原因にはたどり着いたのに「シックリくる改善案が出てこない」ことはありませんか。これは、問題の細分化が十分に行われていないことが原...

  問題の原因にはたどり着いたのに「シックリくる改善案が出てこない」ことはありませんか。これは、問題の細分化が十分に行われていないことが原...


「とにかく書いてみる」とは

1. 何を書いたらいいのかわからない  例えば、「“人生論”についてのあなたの考えを2,000文字以内でまとめて提出しなさい」のような課題が与えられ...

1. 何を書いたらいいのかわからない  例えば、「“人生論”についてのあなたの考えを2,000文字以内でまとめて提出しなさい」のような課題が与えられ...


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

もっと見る
社員教育:日頃の報連相

  1. VIP名簿の大切さ  ブランドメーカーのB社では、書類のファイリングや会議、面談、出張等のスケジューリング管理をすべて社長秘書が担当して...

  1. VIP名簿の大切さ  ブランドメーカーのB社では、書類のファイリングや会議、面談、出張等のスケジューリング管理をすべて社長秘書が担当して...


【SDGs取組み事例】SDGs理念の下、企業と住民が地域課題解決に向け連携

♦「真善美」の考えが人を育む 太陽工業株式会社(長野県諏訪市)  目次・SDGs対応が取り引きや会社選びの基準に・資格認定制度を設け社内...

♦「真善美」の考えが人を育む 太陽工業株式会社(長野県諏訪市)  目次・SDGs対応が取り引きや会社選びの基準に・資格認定制度を設け社内...


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

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

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