文章の揺らぎ

どんな職種でもそうですが、ことSEになると「他者に意図を過不足なく伝える」資料(文章、図形問わず)を書くことが多くなります。

ここで言う他者とはお客様･･･この場合は提案書や要件定義書･･･の場合もあれば、プログラマー･･･この場合は設計書等･･･もあります。
今回は主に「プログラマー」に渡す設計書について書きます。

その資料に”揺らぎ”(複数の意図に取れる)があると受け取った側は質問等をして時間のロスが発生します。
悪いことに、設計書を渡した後は、だいたい設計者は別の仕事をしているため、回答を考えるためにさらに時間がかかります。

まだ質問をしてその”揺らぎ”を確認出来れば良いのですが、受取人の解釈のみで進めると(そしてそれが意図した内容と違うのはよくあります)、大きな手戻りが待っています。
こういうことがよく起こっていくとデスマーチへの歩みを初めてしまます。

また、後日見直した時にもその”揺らぎ”が原因になり、意図が分からないことが起こります。
設計者は”揺らぎ”を意識して「こう」としか解釈しようのない設計書(文章)を書くよう努力する必要があります。
極論ですが変に誤解される設計書より、訳が分からない設計書(＝そのままでは作れない)がマシかもしれません。

「相手が質問しなくては分からない」もしくは「自分の意図と違う風に理解される」文章は”揺らぎ”があり、本来の目的を果たせていない(結果としてそれを作った人の仕事=責任を果たせていない)と思います。

※注意：この記事は旧サウスポーなエンジニアの独り言から移行し一部修正したエントリです。

Photo via VisualHunt.com