「マンガでわかる技術文書の書き方」の説明の第7回として,3つの視点の中の「内容が明確に伝わる技術文書の書き方の技術:6つのルールと18の書き方(その1)」を説明します。
_
2015年度版では「6つのルールと17の書き方」でしたが,2022年度版では「6つのルールと18の書き方」としました。ここで,ルールとは書き方の考え方,書き方とはルールに対する具体的な書き方のことです。
■2015年度版
■2022年度版
ルールと書き方のポイントを説明します。
■ルール1:冒頭に書く
内容に関する主要なことを冒頭に書き,この主要なことに関する説明をその後に書くという考え方に基づくルールです。
◆「書き方1:要点を冒頭に書く」
「結論を冒頭に書く」と同じ考え方の書き方です。様々な書き方を使って内容を書くときに一緒に使える書き方です。書き方1は,例えば,「書き方4:根拠を書く」や「書き方5:条件を書く」を使うときなどに使えます。
◆「書き方2:全体像を冒頭に書く」
「全体から詳細へ」に基づく書き方です。2022年度版で新たに追加した書き方です。
◆「書き方3:枠組みを冒頭に書く」
先行オーガナイザーの考え方を適用した書き方です。先行オーガナイザーとは認知心理学に関係した言葉です。「書き方3:枠組みを冒頭に書く」は,2015年度版での「書き方2:目的を文書の冒頭に書く」,「書き方3:方針を文書の冒頭に書く」および「書き方4:手順を文書の冒頭に書く」の考え方をまとめた書き方です。
■ルール2:ペアで書く
2つで一組になっているものをペア(対)で書くという考え方に基づくルールです。
◆「書き方4:根拠を書く」・「書き方5:条件を書く」
これらは,技術的な内容を書く場合に重要な書き方です。決定事項に対する決定した根拠を書くこと,調査結果や解析結果などを書くときこれらの条件を書くことで,決定事項あるいは調査結果や解析結果が明確に伝わります。
次回に続きます。