本当は良いドキュメントを書きたいプログラマ
勤務先のプログラマ(IT事業に携わるメンバーは社長を含め全員プログラマ)は、基本的にドキュメントを書くことが嫌いです。
たった今も、メンバーと納品が近いプロジェクトのドキュメントの精査について打ち合わせしているところです。
さて、何故プログラマはドキュメントを書くことがいやになるのでしょうか。
少し考えてみました。(もしかしたら、私の会社限定のことかもしれませんが・・・)
・面倒くさい
・丁寧なドキュメントを書く工数を得られない
・使ってもらえない(割に要求が厳しいこともある)
まず、面倒くさいについては、プログラムを書くことだって楽しい事も面倒なこともあるので、
仕事(趣味も?)であれば、多かれ少なかれあることです。
次に、工数を得られない。
プログラムを書くだけで工期がいっぱいいっぱいな案件もあり、なかなかドキュメントを書くことに時間が割けない場合があります。
最後の「使ってもらえない」が、一番かなと思っています。
ものすごく分かりやすいドキュメントを書いたとしても、それを読んでもらえなければ価値がありません。
そのため、ドキュメントに書いてあることでも電話やメールで問い合わせが来ることも多く、そのような案件が積み重なると担当者としては「どうせ書いても読んでもらえないし・・・」とモチベーションが下がってしまいます。
また、ソースコードと共に読めば内容がしっかりと把握できるような内容のものでも、
分量が足りないと受け入れてもらえないこともありますが、
逆に、ドキュメント生成ツールで機械的に生成した担当者自身が読んでもよくわからないようなものは、分量が多いので受け入れてもらえたりします。
こんなドキュメントでは開発が別の会社に移ったときに、すごく困ると思うのですが、実際にあった話です。
私がみている範囲では、ドキュメントを書くことが嫌いと言っているプログラマも、実際には自分のために仕様を文章化して保存していたりしています。
そういったものが役に立つドキュメントなのではないかなと思います。
日本では、SEとプログラマの役割が分かれてしまっていて、
SEの中には、プログラムがよく分からない人もいるため、分量などで評価せざるを得ない場合もあるのだと思います。
しかし、書いている方としてはせっかく書いたので、お客さんの役にたってほしいのです。
少しずつ変わっていけばいいなと思います。