[章番号]: [システム仕様名]
このテンプレートの使い方
このファイルは、プロジェクトのシステム仕様を記述するためのテンプレートです。
新しい機能群の仕様書を作成する際は、このファイルをコピーし、
ファイル名を [章番号]_[仕様名].md のように変更して使用してください。
各セクションのコメントは書き方のヒントです。完成したドキュメントからは削除しても構いません。
詳しい使い方は「システム仕様の書き方ガイド」を参照してください。
1. はじめに
1.1. 目的
1.2. 対象範囲
1.3. 対象読者
2. 全体的な説明
2.1. プロダクトの概要
2.2. 提供価値
- [価値1]: [説明]
- [価値2]: [説明]
3. 機能要件
3.1. [機能カテゴリ名1]
FUNC-CAT-1-1: [要件の名称]
- 要件: [要件内容を簡潔に記述]
- 詳細:
- [要件の詳細1]
- [要件の詳細2]
FUNC-CAT-1-2: [要件の名称]
- 要件: ...
- 詳細: ...
4. 非機能要件 (品質特性)
4.1. パフォーマンス
PERF-GEN-1-1: [パフォーマンス要件の名称]
- 要件: [具体的な性能目標を記述。例: APIの応答時間は95パーセンタイルで500ms未満であること。]
- 詳細: ...
4.2. セキュリティ
SEC-GEN-1-1: [セキュリティ要件の名称]
- 要件: [具体的なセキュリティ要件を記述。例: 全ての機密データは保存時に暗号化されること。]
- 詳細: ...
4.3. 信頼性
REL-GEN-1-1: [信頼性要件の名称]
- 要件: [具体的な信頼性目標を記述。例: システムの年間ダウンタイムは8時間以内であること。]
- 詳細: ...
4.4. 保守性
MAINT-GEN-1-1: [保守性要件の名称]
- 要件: [具体的な保守性要件を記述。例: 新機能の追加やバグ修正が容易であること。]
- 詳細: ...
4.5. 運用性
OPS-GEN-1-1: [運用性要件の名称]
- 要件: [具体的な運用性要件を記述。例: ログが適切に出力され、監視可能であること。]
- 詳細: ...
4.6. 拡張性
EXT-GEN-1-1: [拡張性要件の名称]
- 要件: [具体的な拡張性要件を記述。例: 将来的な機能追加やユーザー増加に対応できること。]
- 詳細: ...
4.7. 可用性
AVAIL-GEN-1-1: [可用性要件の名称]
- 要件: [具体的な可用性要件を記述。例: システムの稼働率は99.9%以上であること。]
- 詳細: ...
5. 設計と実装の制約
5.1. [制約カテゴリ名]
CONST-FW-1-1: [制約の名称]
- 制約: [制約内容を記述。例: ターゲットフレームワークは .NET 8 とする。]
- 詳細: ...
6. その他の要件
OTHER-LIC-1-1: [要件の名称]
- 要件: [要件内容を記述。例: MIT Licenseを採用すること。]
- 詳細: ...
7. 用語定義
| 用語 | 説明 |
|---|---|
| API | Application Programming Interfaceの略。 |
| CLI | Command Line Interfaceの略。 |
| DB | Databaseの略。 |
| UI | User Interfaceの略。 |
| UX | User Experienceの略。 |
| SLA | Service Level Agreementの略。 |
| SLO | Service Level Objectiveの略。 |
| SLI | Service Level Indicatorの略。 |
| JWT | JSON Web Tokenの略。 |
| OAuth2 | 認証・認可のためのオープン標準。 |
| REST | Representational State Transferの略。 |
| gRPC | Google Remote Procedure Callの略。 |
| GraphQL | APIのためのクエリ言語。 |
| CI/CD | Continuous Integration / Continuous Delivery |