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

今回は,「内容が明確に伝わる技術文書の書き方の3原則」ので「第2原則」の概要の解説です。

書き方の第2原則とは,内容が明確に伝わる技術文書の構成(骨組み)を考えることです。内容が明確に伝わる技術文書の構成(骨組み)を考えるうえでのポイントは以下の4つです。

①内容を項目に区分する
②技術文書の軸を決める
③軸となる項目を細分化する
④技術文書のストーリーを確認する

どのような技術文書を書くときにもこの4つのポイントに基づき「内容が明確に伝わる技術文書の構成」を考えます。例えば,用紙200枚で書く報告書用紙1枚で書く会議の資料もこの4つのポイントに基づき構成を考えます。また,メールを書くときにもメールの構成を考えます。

次回に続きます。

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

トップへ戻る