内容が明確に伝わる技術文書の書き方（その9）

投稿日 2022-10-06

...

技術文書

今回は、「内容が明確に伝わる技術文書の書き方の第２原則（内容が明確に伝わる構成を考える）」と「内容が明確に伝わる技術文書の書き方の第３原則（内容が明確に伝わる書き方を考える）」についての解説です。

１．「書き方の第２原則」とは

書き方の第２原則とは、内容が明確に伝わる技術文書の構成（骨組み）を考えることです。書き方の第２原則は、内容が明確に伝わる技術文書を具体的に書くうえでのスタートです。内容が明確に伝わる技術文書の構成を考えることで、内容が明確に伝わる技術文書を書くことができます。

技術文書

内容が明確に伝わる技術文書の構成（骨組み）を考えるうえでのポイントは以下の４つです。

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

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

２．「書き方の第３原則」とは

書き方の第３原則とは、内容が明確に伝わる書き方を考えることです。すなわち、内容が明確に伝わる技術文書の構成（骨組み）に「６つのルールと18の書き方」を使って肉付けをすることです。

2.1　「６つのルールと18の書き方」とは

「６つのルールと18の書き方」を以下に示します。

人財教育

2.2　「６つのルール」とは

６つのルールとは、内容が明確に伝わる技術文書を書くうえでの書き方の考え方のことです。「冒頭に書く、ペアで書く、分けて書く、視覚的に書く、合わせて書くおよび明確に伝わる文を書く」という６つのルールがあります。

2.3　「18の書き方」とは

18の書き方とは、6つのルールに対する具体的な書き方のことです。６つのルールは書き方の考え方なので、この考え方に対応した具体的な書き方が18の書き方です。この18の書き方を使って技術文書の構成に肉付けをします。また、この18の書き方は、報告書、会議や打ち合わせで使う資料、提案書、企画書、メールなどあらゆる技術文書を書くときに使えます。このことは、例えば、「書き方1は、報告書を書くときにもメールを書くときにも使える」のようなことです。

次回に続きます。

【参考文献】

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

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

◆関連解説『人財教育とは』

　続きを読むには・・・

新規会員登録