今回は、「内容が明確に伝わる技術文書の書き方の第2原則(内容が明確に伝わる構成を考える)」と「内容が明確に伝わる技術文書の書き方の第3原則(内容が明確に伝わる書き方を考える)」についての解説です。
【この連載の前回:内容が明確に伝わる技術文書の書き方(その8)へのリンク】
1.「書き方の第2原則」とは
書き方の第2原則とは、内容が明確に伝わる技術文書の構成(骨組み)を考えることです。書き方の第2原則は、内容が明確に伝わる技術文書を具体的に書くうえでのスタートです。内容が明確に伝わる技術文書の構成を考えることで、内容が明確に伝わる技術文書を書くことができます。
内容が明確に伝わる技術文書の構成(骨組み)を考えるうえでのポイントは以下の4つです。
- ①内容を項目に区分する
- ②技術文書の軸を決める
- ③軸となる項目を細分化する
- ④技術文書のストーリーを確認する
この4つのポイントは、技術文書の枚数や技術文書の種類とは無関係です。どのような技術文書を書くときにもこの4つのポイントに基づき「内容が明確に伝わる技術文書の構成」を考えます。例えば、用紙200枚で書く報告書も用紙1枚で書く会議の資料もこの4つのポイントに基づき構成を考えます。また、メールを書くときにもメールの構成を考えます。
2.「書き方の第3原則」とは
書き方の第3原則とは、内容が明確に伝わる書き方を考えることです。すなわち、内容が明確に伝わる技術文書の構成(骨組み)に「6つのルールと18の書き方」を使って肉付けをすることです。
2.1 「6つのルールと18の書き方」とは
「6つのルールと18の書き方」を以下に示します。
2.2 「6つのルール」とは
6つのルールとは、内容が明確に伝わる技術文書を書くうえでの書き方の考え方のことです。「冒頭に書く、ペアで書く、分けて書く、視覚的に書く、合わせて書くおよび明確に伝わる文を書く」という6つのルールがあります。
2.3 「18の書き方」とは
18の書き方とは、6つのルールに対する具体的な書き方のことです。6つのルールは書き方の考え方なので、この考え方に対応した具体的な書き方が18の書き方です。この18の書き方を使って技術文書の構成に肉付けをします。また、この18の書き方は、報告書、会議や打ち合わせで使う資...
次回に続きます。
【参考文献】
森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日