説明することの難しさ

最近は、納品のためのドキュメントや、執筆など説明するものを書くことが多いのですが、きちんと読み手に理解してもらえる文章を書くことは難しいことですよね。

特に、機能の技術的な説明は、要求する前提知識が偏っていたり、書き手がそもそも整理して理解できていなくて、難解な文章になりがちです。
難解な文章になると、そもそも理解してもらえなかったり、いろいろな捉え方ができてしまったり、危険です。

もし自分で、難解な文章になってしまったと感じたときは、「その分野が苦手な人」に読んでもらうといいかもしれません。
私の場合、主にネットワークを扱うプログラムのドキュメントを書くので、ネットワークがあまり得意ではないメンバーに読んでもらうようにしてみました。
そうすると、「ここの言い回しが、何が言いたいのかわからない・・・」と率直に意見してくれます。
得意な人は、性格にも依るでしょうが、空気を読んでくれてしまうので、実際納品したときに差し戻されてしまうかもしれませんので。

とはいえ、日頃から沢山文章を書く練習をすることが一番大事ですね。