システム開発ドキュメント一覧
1. 要件定義フェーズ
- 要件定義書
- システムの機能要件、非機能要件を整理。
- ユースケース図・シナリオ
- ユーザーの行動とシステムの動作を具体化。
- ペルソナ・ユーザーストーリー
- 代表的なユーザー像と利用シナリオ。
- 現状分析レポート
- 現行システムや業務プロセスの問題点。
2. 設計フェーズ
- 基本設計書（概要設計書）
- システム全体の構造や主要機能の概要を記述。
- 詳細設計書
- 個別の機能や画面、データの詳細設計。
- データベース設計書
- テーブル構造、ER図、インデックス設計。
- API設計書
- エンドポイント、リクエスト・レスポンスの仕様。
- UI/UX設計書
- 画面遷移図、デザインモックアップ。
- サーバー構成図
- サーバーやネットワーク、通信の構造を図式化。
- セキュリティ設計書
- 認証方式、暗号化、アクセス制御の設計。
3. 開発フェーズ
- 開発計画書
- スケジュール、リソース割り当て、進捗管理方法。
- コーディング規約
- プログラミングの統一ルール。
- バージョン管理ポリシー
- ソースコードの変更履歴とブランチ戦略。
- サーバー設定仕様書
- サーバーOSやミドルウェアの設定内容。
- ログ仕様書
- 収集すべきログの種類と用途。
4. テストフェーズ
- テスト計画書
- テストスコープ、スケジュール、リソース。
- テストケース仕様書
- テスト項目、入力データ、期待される出力。
- テスト結果報告書
- テストの成功/失敗結果と改善案。
- バグレポート
- 不具合の詳細な記録。
- 負荷テスト・パフォーマンステスト結果
- システムの性能テストの結果。
5. デプロイ・運用フェーズ
- デプロイ手順書
- 本番環境への導入手順。
- リリースノート
- 実装済みの機能や修正点。
- 運用マニュアル
- 日常運用業務やトラブルシューティング。
- 障害対応手順書
- 障害発生時の復旧手順。
- 監視設定仕様書
- 監視ツールの設定内容とアラート条件。
- バックアップポリシー
- バックアップの頻度、手法、保管場所。
6. プロジェクト管理
- プロジェクト計画書
- 開発の全体計画。
- リスク管理計画書
- 想定リスクとその対策。
- 議事録
- 会議内容や決定事項の記録。
- 変更管理記録
- 要件や仕様の変更履歴。
7. メンテナンスフェーズ
- システム更新履歴
- 変更点や更新内容の記録。
- ユーザーマニュアル
- エンドユーザー向けの使い方ガイド。
- FAQドキュメント
- よくある質問とその解答。
- サーバー資産管理表
- サーバーの情報（IP、ホスト名、仕様）。
- ライセンス管理台帳
- ソフトウェアのライセンス情報。
8. サーバー関連特化
- サーバー構成一覧
- サーバー名、IP、ホスト名、使用用途、OS。
- ネットワークトポロジー図
- サーバー間通信やネットワーク全体の接続関係。
- インシデント対応計画書
- サーバー障害やセキュリティ問題時の対応手順。
この一覧をベースに、プロジェクトの規模や目的に応じてドキュメントを取捨選択すると効果的です。
コメント