オルタナティブ・ブログ > 技術屋のためのドキュメント相談所 >

専門的な情報を、立場の違う人に「分かるように説明する」のは難しいものです。このブログは「技術屋が説明書や提案書を分かりやすく書く」ために役に立つ情報をお届けします。

1つの文では1つのことだけを書こう

»

最近ある会社で研修をして事後課題として「障害報告を図解レポートで書く」という宿題を出したのですが、その解答を見ていて目立った「わかりにくい文」の典型的な例の1つです。

障害報告をする時にはよくやりがちなんですが、「本来はこうあるべきだが、実際にはこうなっていた」 という書き方、よくありますよね? 自然な発想でつい書いてしまうものですけど、こういうふうな「1つの文で2つのことを説明する」書き方はやらないほうがいいんです。

「1つの文で1つのことだけを語る」=単文、を使って書くようにしましょう。

Labeling-basics-5-p2.PNG

特に複文のほうは「係り受け」の構造が複雑化しやすく、読み取りにくい文を書いてしまいがちなので、使わないことが望ましいです。

Labeling-basics-5-p3.PNG

障害報告というのは「本来」と「実際」という2つの情報がたいてい出てくるので、ついつい混合文で書いてしまいがちです。

Labeling-basics-5-p6.PNG

というわけで、私がいつも言っていることですが、ラベルつき箇条書きを使いましょう!

Labeling-basics-5-p7.PNG

(当記事は筆者の公式サイトの「ラベリングの基本 #5 単文推奨の原則 」という記事をもとにしています。公式サイトでは他にも図解/文章/説明する技術についてのノウハウ・事例を掲載しています)

Comment(0)