...
内容が明確に伝わる技術文書の書き方（その22）
投稿日 2022-11-16
1.「内容が明確に伝わる技術文書の書き方の３原則」を判断基準にする
「内容が明確に伝わる技術文書の書き方（その21）」では、「６つのルールと18の書き方」を「わかりにくい」に対する判断基準にすることを解説しました。
【この連載の前回：内容が明確に伝わる技術文書の書き方（その２１）へのリンク】
「内容が明確に伝わる技術文書の書き方（その2）」で解説した「内容が明確に伝わる技術文書の書き方の３原則」の中での「第２原則：内容が明確に伝わる構成を考える」も「わかりにくい」に対する判断基準になります。
技術文書の構成は技術文書の骨組みです。技術文書の骨組みがしっかりしていないと内容が明確に伝わりません。
「内容が明確に伝わる技術文書の書き方（その13）」の中で【パターンⅠ】として以下のメールの内容を書きました。
【メールのパターンⅠ】
昨日Ａ社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。
「Ａ社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する」とのことだった。
「今週の木曜日の17時までに、効果と削減額をＡ社の山田部長までメールで送って欲しい」との指示があった。
〇月〇日の10時からＡ社で行う次回の打ち合わせでＡ社の結論を話す。
以 上
このメールには構成がありません。このような書き方では内容が明確に伝わりません。「内容が明確に伝わる技術文書の書き方（その13）」の中では、「書き方の第２原則」に基づきメールの構成を考えた【パターンⅡ】のメールの内容を書きました。
【メールのパターンⅡ】
昨日Ａ社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。
１．打ち合わせでの結論
〇〇管理システムの導入に関する結論は出なかった。Ａ社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する。
２．打ち合わせでの指示事項
今週の木曜日の17時までに、効果と削減額をＡ社の山田部長までメールで送る。
３．今後の予定
〇月〇日の10時からＡ社で行う次回の打ち合わせでＡ社の結論を話す。
以 上
このメールでは、「１．打ち合わせでの結論」、「２．打ち合わせでの指示事項」および「３．今後の予定」を項目とした構成を考えて書きました。このように書くことで内容が明確に伝わります。
このように、技術文書の構成の有無で「この書き方はわかりにくい（内容が明確に伝わらない）」と判断することができます。すなわち、「書き方の第２原則：内容が明確に伝わる構成を考える」も「わかりにくい」の判断基準になります。結論として、「６つのルールと18の書き方」と「書き方の第２原則：内容が明確に伝わる構成を考える」が「わかりにくい」に対する判断基準になります。
前回と今回で解説したように、「わかりにくい（内容が明確に伝わらない）」に気が付き、それを、「わかりやすい（内容が明確に伝わる）」に修正することで内容が明確に伝わる技術文書を書くことができます。
次回に続きます。
【参考文献】
森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
続きを読むには・・・
「人財教育・育成」の他のキーワード解説記事
もっと見る
自分の仕事に余裕を作るには
1. 「捨てる」スキル ◆商品開発に「捨てる」はもう常識 今回は、日々の仕事と商品仕様における「捨てる」スキルについ...
1. 「捨てる」スキル ◆商品開発に「捨てる」はもう常識 今回は、日々の仕事と商品仕様における「捨てる」スキルについ...
視覚的に書くとは
ここ数年、毎年のように各地で激しい雨が降っています。先日も、台風7号や活発化した梅雨前線の影響で九州地方から近畿地方にかけて大雨となりました。こ...
ここ数年、毎年のように各地で激しい雨が降っています。先日も、台風7号や活発化した梅雨前線の影響で九州地方から近畿地方にかけて大雨となりました。こ...
「A3報告書」の活用とは
1. 社会人基礎力の必要性 解説記事「ものづくりで求められる『考え抜く力』とは」の中で、「考え抜く力」と「メタ認知」の重要性について解説し...
1. 社会人基礎力の必要性 解説記事「ものづくりで求められる『考え抜く力』とは」の中で、「考え抜く力」と「メタ認知」の重要性について解説し...
「人財教育・育成」の活用事例
もっと見る
人材の課題 伸びる金型メーカーの秘訣 （その20）
今回、取り上げる金型メーカーは、I 精機株式会社です。同社は、高い職人技術で、金型製作から試作板金、部品加工まで幅広く手がけてきましたが、今後はその職人...
今回、取り上げる金型メーカーは、I 精機株式会社です。同社は、高い職人技術で、金型製作から試作板金、部品加工まで幅広く手がけてきましたが、今後はその職人...
やろうと思っているけどできないことばかり、の克服（その4）
前回は絞り込んでもなお、やりたいけどできないことに対して心理的抵抗を整理しました。ちょっと面倒だったと思いますけど、やりましたか？ や...
前回は絞り込んでもなお、やりたいけどできないことに対して心理的抵抗を整理しました。ちょっと面倒だったと思いますけど、やりましたか？ や...
中国のクリーン化担当女性の事例
私が足繁く通っていた、中国の工場の女性クリーン化担当の話です。その工場は上海から車で2時間ほどのところにあり、約1万人の社員を抱えていました。その女性は...
私が足繁く通っていた、中国の工場の女性クリーン化担当の話です。その工場は上海から車で2時間ほどのところにあり、約1万人の社員を抱えていました。その女性は...
