「内容が明確に伝わる技術文書の書き方(その30)」で「必要なこと」として「伝える内容を明確に理解していること」と「頭の中を整理すること」の2項目についての概要を解説しました。今回は「頭の中を整理すること」に関する解説です。
【この連載の前回:内容が明確に伝わる技術文書の書き方(その33)へのリンク】
1.頭の中の整理方法
「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って書くことは頭の中を整理して技術文書を書くことです。これまで解説した内容に基づきこのことについて解説します。
1.1 頭の中の整理方法(その1)
「内容が明確に伝わる技術文書の書き方(その13)」で、メールの書き方として【パターンⅠ】と【パターンⅡ】の書き方を解説しました。「メールには、これを書こう、これを書かなきゃ、あれを書こう、あれも書かなきゃ・・・」のような頭の中が未整理の状態で書くと、内容が明確に伝わらない【パターンⅠ】のような文の羅列で書いたメールになります。
しかし「書き方の第2原則(内容が明確に伝わる構成を考える)」と「書き方1(要点を冒頭に書く)」を使って頭の中を整理すると【パターンⅡ】のような内容が明確に伝わるメールを書くことができます。
1.2 頭の中の整理方法(その2)
「内容が明確に伝わる技術文書の書き方(その8)」で考えます。「車の主な種類」を書く場合「『車の主な種類』としてこれを書こう、これを書かなきゃ、あれを書こう、あれも書かなきゃ・・・」のような頭の中が未整理の状態で書くと文の羅列で書いた内容になります。文の羅列で書くと内容が明確に伝わりません。
しかし「内容が明確に伝わる技術文書の書き方(その14)」や「内容が明確に伝わる技術文書の書き方(その15)」で解説したように「書き方6(かたまりに分けて書く)」「書き方8(表で書く)」「書き方10(強調して書く)」を使って頭の中を整理すると内容が明確に伝わる「車の主な種類」を書くことができます。
技術文書を書く場合には「これを書こう、これを書かなきゃ、あれを書こう、あれも書かなきゃ・・・」のような状態で一気に書き出さないでください。一旦立ち止まり上記の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って頭の中を整理してください。頭の中を整理して書...
次回に続きます。
【参考文献】
森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!