/note/tech
- (1)要件定義書
- なぜその機能が必要なのか、解決するべき課題について述べたもの
- 課題、理想像、期限などが記述される
- (2)操作マニュアル、運用マニュアル
- (3)外部システムIF仕様書、外部システム連携仕様書(図)
- (4)アーキテクチャ設計書
- システムがどのようなアーキテクチャで構成されているか説明するもの
- 主に開発者が読む
- システム全体、アプリケーション、必要ならDB
- (5)ER図、データ構造設計書
- (6)設計上の意思決定を記録したメモ
- 実装がそのようになっている理由を示したドキュメント
- ドキュメントというよりはメモに近い
- ソースコードと同じリポジトリで管理されることが望ましい
こんな感じか。
以前にも似たような事を書いていた。
(2019/06/14)