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

今回は,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その14)」の続きです。前回は,文の羅列で書いた内容を,「書き方6:かたまりに分けて書く」を使って書きました。今回は,これと異なる書き方で書いた場合の解説です。

_

=

パターンⅡ注):ルール3(分けて書く)・「書き方8:表で書く」
パターンⅡは,文の羅列で書いた内容を,「ルール3(分けて書く)・『書き方8:表で書く』」を使って書きました。結果を以下に示します。

注):「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その14)」で書いた書き方(書き方6:かたまりに分けて書く)パターンⅠとします。

書き方8を使って表で書く場合,表の内容を一層明確に伝える方法として「書き方10:強調して書く」を使い重要な内容を強調して書きました。以下が強調して書いた内容です。

表のタイトル(「表 車の種類・定義・特長」)と表の項目(車の種類・定義・特長)を強調して書く。
*フォントをゴシック体にする。

定義および特長での重要な内容を強調して書く。
*アンダーラインを付ける。

パターンⅢ:ルール3(分けて書く)・「書き方8:表で書く」+ルール4(視覚的に書く)・「書き方9:写真や図を入れて書く」

パターンⅢは,「ルール3(分けて書く)・『書き方8:表で書く』」と「ルール4(視覚的に書く)・『書き方9:写真や図を入れて書く』」を組み合わせて書きました。また,書き方8を使って表で書く場合,パターンⅡと同様に「書き方10:強調して書く」を使って重要な内容を強調して書きました。結果を以下に示します。

【まとめ】
「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その14)」と「同(その15)・今回」で,文の羅列で書いた内容を以下の3パターンで書きました。

パターンⅠ「書き方6:かたまりに分けて書く」+「書き方10:強調して書く」
パターンⅡ「書き方8:表で書く」+「書き方10:強調して書く」
パターンⅢ「書き方8:表で書く」+「書き方9:写真や図を入れて書く」+「書き方10:強調して書く」

文の羅列で書いた内容をこれらの3パターンの書き方で書くことで内容が明確に伝わります

文の羅列で書いた内容を内容が明確に伝わるように書く場合,内容によっては,「書き方7:箇条書きで書く」を使って書くこともできます。

内容が明確に伝わる技術文書を書く場合には,伝える内容に基づき,「6つのルールと18の書き方」の中から書き方を選んで技術文書を書きます。

次回に続きます。

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

トップへ戻る

This will close in 20 seconds

This will close in 20 seconds