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

今回は,「ルール4:視覚的に書く」に関する補足解説です。

ルール4:視覚的に書く
「ルール4:視覚的に書く」とは,「見せる」という視点で書くことで内容を明確に伝える書き方です。具体的には以下の書き方があります。

①書き方9:写真や図を入れて書く
②書き方10:強調して書く
③書き方11:まとまりを持たせて書く

ルール4以外のルールは,「書き方を考えることで内容を明確に伝える」という考え方での書き方です。例えば,「書き方1:要点を冒頭に書く」での「内容に関する要点を冒頭に書き,この要点に関する説明をその後に書くこと」という考え方です。

このように,ルール4と他のルールでは書き方の考え方が異なります。

書き方を考えることで内容を明確に伝える
例えば,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その15)」では,文の羅列で書いた内容を表で書きました。これは,「文の羅列で書いた内容を表で書く」のように書き方を考えました。表で書くことで内容が明確に伝わります。
注):この表では,表の内容を一層明確に伝えるため表の中の重要な内容にアンダーラインを引いて強調しています。これは、「書き方10:強調して書く」という考え方です。

「見せる」という視点で書くことで内容を明確に伝える
『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その15)」では写真を入れた表も解説しました。これは,「書き方を考えることで内容を明確に伝える」という書き方と「『見せる』という視点で書くことで内容を明確に伝える」という書き方を組み合わせて書いたものです。表の中に写真を入れることで,「車の定義や特長」と「車の写真」が結びつき車の種類の違いが明確に伝わります。
注):この表でも「書き方10:強調して書く」を使っています

=

「見せる」という視点で書く
「見せる」という視点での書き方はあらゆる技術文書を書くときに使えます。例えば,メールを書くときにも使えます。「書き方10:強調して書く」を使ってメールの中の重要な内容にアンダーラインを引いたり重要な内容を着色したりすれば内容を明確に伝えることができます。

読み手の立場で技術文書を読むことを考えれば,「ルール4:視覚的に書く」つまり「見せる」という視点で書くことは,内容が明確に伝わる技術文書を書くうえでの重要な書き方だということがわかると思います。

【参考】
今回解説した「視覚的に書く」に関係した内容は,2016年7月8日に掲載した「視覚的に説明する」をテーマにしたブログでも解説しました。

次回に続きます。

【参考文献】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和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