ソースに対するドキュメントのメンテナンス方法
APIの説明はdoxygen形式でソースにつけるのがいい。
問題はアーキテクチャの説明とかのドキュメントをどう管理するか。
- txtでSVNに入れる
- 利点: ソースと同期できる
- 欠点: 画像が見難い
- 欠点: タグが使えない
- pukiwiki
- 利点: 画像が見やすい
- 欠点: リビジョン管理できない
- mediawiki
- 利点: 画像が見やすい
- 利点: リビジョン管理ができる
- 利点: ノートページでディスカッションができる
- 欠点: ソースとリビジョンが自動で同期されない
- wordをSVNに入れる
- 利点: ソースと同期できる
- 利点: 画像が見やすい(?)
- 欠点: 画像を更新しすぎると重くなる?
- 欠点: 差分が見づらい
- 欠点: 更新しすぎると重くなる?
- htmlと画像をSVNに入れる
- 利点: ソースと同期できる
- 利点: 画像が見やすい
- 欠点: 画像を更新しすぎると重くなる?