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

「6つのルールと18の書き方」を判断基準にする
『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その20)」のブログの中で以下のことを書きました。

 

「この書き方はわかりにくい(内容が明確に伝わらない)」と気が付くためには,「どのような書き方をしたらわかりにくいか」という「わかりにくい」に対する判断基準が必要です。

 

これまで,「6つのルールと18の書き方」について解説しました。この「6つのルールと18の書き方」「わかりにくい」に対する判断基準になります。

「6つのルールと18の書き方」を使って書けば内容が明確に伝わる技術文書(わかりやすい技術文書)を書くことができます。逆に言うと,「6つのルールと18の書き方」に反した書き方で書けば内容が明確に伝わらない(わかりにくい)技術文書になります。つまり,「6つのルールと18の書き方」「わかりにくい」に対する判断基準になります。例えば,以下のようなことです。

 

*内容の要点を冒頭に書いてないのでわかりにくい。
「書き方1:要点を冒頭に書く」に反している。

*文の羅列で書いてあるのでわかりにくい。
「書き方6:かたまりに分けて書く」に反している。

*写真がないのでわかりにくい。
「書き方9:写真や図を入れて書く」に反している。

*具体的な文を書いてないのでわかりにくい。
⇒「書き方13:具体的な文を書く」に反している。

 

また,「6つのルールと18の書き方」を使って,「わかりにくい(内容が明確に伝わらない)書き方」「わかりやすい(内容が明確に伝わる)書き方」に修正することができます。例えば,以下のようことです。

 

*内容の要点が文章の最後に書いてあるのでわかりにくい。
⇒「書き方1:要点を冒頭に書く」を使って修正しよう。

*この箇所は文の羅列で書いてあるのでわかりにくい。
⇒「書き方6:かたまりに分けて書く」を使って修正しよう。

*「○○駅では,4月から△△線と□□線との乗り換えが同一ホームでできるようになった。その結果,鉄道利用者の利便性が向上した」と書いてあるのでわかりにくい。
⇒「書き方13:具体的な文を書く」を使って修正しよう。

 

このように,「6つのルールと18の書き方」は,「わかりにくい」に対する判断基準になります。また,「わかりにくい」「わかりやすい」に修正する方法として使えます。

 

次回に続きます。

 

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

タイトルとURLをコピーしました