「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方(その22)

『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その21)」では,「6つのルールと18の書き方」「わかりにくい」に対する判断基準にすることを解説しました。

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

『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その12)」の中で【パターンⅠ】として以下のメールの内容を書きました。

このメールには構成がありません。このような書き方では内容が明確に伝わりません。
=

『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その12)」の中では,「書き方の第2原則」に基づきメールの構成を考えた【パターンⅡ】のメールの内容を書きました。

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

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

これまで解説したように,「6つのルールと18の書き方」と「書き方の第2原則:内容が明確に伝わる構成を考える」が「わかりにくい」に対する判断基準になります。

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

次回に続きます。

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

トップへ戻る