定期購読している Software Design の10月号が届きました
今回のお題はドキュメントです
ドキュメント・・・。難しいですよね。
本書の中でも書かれていますが、結局のところシーンによって必要となるドキュメントは変わるし、誰が何に対して責任を持つのかが整備されているプロジェクトは結構少ない。
単発モノで終わるプロジェクトであれば、改修することは少ないのでそれほど重厚なドキュメントは不要なこともあるし、長期的に開発を回していくようなプロダクトであれば、経緯を含めたドキュメントが欲しくなります。
一方で、数ある「こういうドキュメント作ったほうがいいよ」の種類は膨大にあり、作りすぎることでメンテナンスコストが大きくなる。もしくは、メンテナンスされなくなってしまうような事態を引き起こします。
種類や方法がやたら多いということは、結局のところ全てのプロジェクトで共通で使うといいという手法なんてないんですよね。
なので、初期段階で何を作って何を作らないかを決めないといけない。
「こういう情報欲しいな」って話があるとちょっと作る。
ただ、このレベルだと保守されないことのほうが多い。ただ、一度作ってしまった以上は・・・ということが起きるんですよね。
苦しい・・・
でも、契約別に事例が載っているのは非常に面白いと思った。
若手メンバーにオススメしたい一冊だと思う