ドキュメントについて考える

ドキュメントの目的

大きく２つかと思います。

• これから何をつくるのかを表現
• なにを作ったのかを表現

上記２つを一種類のドキュメントで兼ねようとすると、うまく管理できない気がします。

これから何をつくるのか

主にステークホルダー間でこれから何を作るのか（どう変更するのか）を共有するためのもの。ドキュメントの体裁はどうでもよく、ホワイトボードのメモとか、そんなのでもいいと思ってます（ただし、他の会社がからむ場合は別） 合意事項のログなので、S-in後にメンテする必要もないです。

なにを作ったのか

結果的に何が作られたのか？（例：クラス図とかテーブル仕様書など）を表現したもの。後からチームに人が入ってきた時に、担当システムの学習資料になります。「コードを読めばわかる」のであれば特別用意する必要はないとおもってます（ただし、「コードを読めばわかる」コードになっているかどうかは話は別）というかコードから自動生成する方が今っぽいですね。

残す目的が大事

結局のところ、プロジェクトに関してどの情報を残しておく必要があるか（例：テーブル定義）を意識し、それをどこで表現するか（例：ER図、ソースコード）を考えることが大事だと思います。