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

解説した“書き方”の整理
『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その10)」から「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その18)」で,「6つのルールと18の書き方」の具体的な使い方の一例を解説しました。この9回で解説した“書き方”を整理します。

(1)「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方その10その11その12その13
①ルール1(冒頭に書く)・「書き方1:要点を冒頭に書く」
*その12は,「書き方の第2原則(内容が明確に伝わる構成を考える)」「書き方1(要点を冒頭に書く)」の組み合わせでの書き方

(2)「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方その14
①ルール3(分けて書く)・「書き方6:かたまりに分けて書く」
②ルール4(視覚的に書く)・「書き方10:強調して書く」

(3)「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方その15
①ルール3(分けて書く)・「書き方8:表で書く」
②ルール4(視覚的に書く)・「書き方9:写真や図を入れて書く」
③ルール4(視覚的に書く)・「書き方10:強調して書く」

(4)「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方その16
①ルール6(明確に伝わる文を書く)・「書き方13:具体的な文を書く」

(5)「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方その17その18
①ルール6(明確に伝わる文を書く)・「書き方16:短い文を書く(一文一義で書く)」

このように,「6つのルールと18の書き方」を使って書くことで内容が明確に伝わる技術文書を書くことができます。ここで解説しなかったこれら以外の書き方を使っても内容が明確に伝わる技術文書を書くことができます。

「書き方2:全体像を冒頭に書く」について
今回は,「ルール1(冒頭に書く)」について,「書き方1:要点を冒頭に書く」だけを対象にしてその具体的な書き方の例を解説しました。「書き方2:全体像を冒頭に書く」の具体的な書き方の例は,2018年9月9日に掲載した「『全体から詳細へ』の考え方でまとめる」というテーマのブログを参考にしてください。

次回に続きます。

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

トップへ戻る

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds