今回は，「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方（その47）」です。
■「わかりにくい書き方」がわかる
前回のブログで，「日々のオンザジョブトレーニングで『内容が明確に伝わる技術文書の書き方の３原則』と『６つのルールと18の書き方』を習得することで，『どのような書き方がわかりにくいのか』ということが判断できる基準ができる」と解説しました。
「内容が明確に伝わる技術文書を書くことができる」とは，「わかりにくい書き方（＝内容が明確に伝わらない書き方）」がわかるということです。つまり，「どのような書き方がわかりにくいのか」が判断できる基準を持っているということです。例えば，この判断基準があれば，「文の羅列で書くとわかりにくい（＝内容が明確に伝わらない）」ということがわかります。
わかりにくい書き方がわかることで内容が明確に伝わる技術文書を書くことができます。技術文書を書くとき，わかりにくい書き方を避ける意識が働くからです。例えば，「文の羅列で書かないようにしよう」などのような意識です。
■自己添削で特に重要
前回のブログでも書きましたが，「わかりにくい書き方がわかること」は自己添削で特に重要です。自己添削でのポイントは，自分の書いた技術文書を読み「わかりにくい」という書き方に気が付くことです。それを修正して内容が明確に伝わる技術文書を書くことが自己添削の目的です。例えば，文の羅列で書いてあっても「問題なし」と判断したら自己添削の目的が達成できません。
「人の振り見て我が振り直せ」ということわざがあります。「他人の行動を見て，良いところは見習い悪いところは改めよ」のような意味です。自己添削とは，「人の振り見て我が振り直せ」のようなことです。わかりにくい書き方を見てそれを改めることで内容が明確に伝わる技術文書を書くことができるからです。
■内容が明確に伝わる技術文書を書くための条件
「わかりにくい書き方がわかること」つまり「どのような書き方がわかりにくいのか」が判断できる基準を持つことが，内容が明確に伝わる技術文書を書くための条件の一つです。
次回に続きます。
【参考文献】
森谷仁著，「マンガでわかる技術文書の書き方」，オーム社，令和4年3月25日
