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

「わかりにくい(内容が明確に伝わらない)書き方」に気が付く

『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その4)」というテーマのブログの中で以下のことを書きました。

 

自分が読んでわかりにくい(内容が明確に伝わらない)と思うような技術文書は,読み手にとってもわかりにくいはずだ。そのため,自分が読んでわかりにくいと思う技術文書を書くべきではない。

 

このような認識を持つためには,自分が書いた技術文書を読み返したとき「この部分のこの書き方はわかりにくい(内容が明確に伝わらない)」ということに気が付く必要があります。例えば,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その4)」のブログで書いたような文の羅列で書いてある内容を読んだとき,「文の羅列で書いてあるとわかりにくい(内容が明確に伝わらない)」と気が付くことです。

 

書いた内容を確認するだけは,「この書き方はわかりにくい(内容が明確に伝わらない)」ということに気が付きません。書いた内容の確認とともに「明確に伝わるかどうか」という確認も必要です。

 

つまり,技術文書を書いたら「自分が読み手だったらこの書き方でわかるか(内容が明確に伝わるか)」という視点での書き方の確認が必要です。

 

「この書き方はわかりにくい(内容が明確に伝わらない)」と気が付くためには,「どのような書き方をしたらわかりにくいか」という「わかりにくい」に対する判断基準が必要です。判断基準がないと,自分が書いた技術文書を読み返しても「わかりにくい(内容が明確に伝わらない)書き方」に気が付きません。

 

判断基準があることで,「わかりにくい(内容が明確に伝わらない)書き方」に気が付きます。

 

【参考】
今回のブログの内容に関係したブログを2017年8月19日に掲載しました。「わかりにくい案内図」というテーマのブログです。「自分が読み手だったらこの書き方でわかるか(内容が明確に伝わるか)」という視点で案内図を見れば,「この案内図はわかりにくい(内容が明確に伝わらない)」ということに気が付くはずです。

 

次回に続きます。

 

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

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