kotonoha 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/README.md +95 -20
- package/bin/kotonoha.js +81 -13
- package/package.json +7 -3
- package/skills/presentation-planner/SKILL.md +243 -0
- package/skills/presentation-planner/assets/design-templates/data-report.yaml +97 -0
- package/skills/presentation-planner/assets/design-templates/executive-proposal.yaml +92 -0
- package/skills/presentation-planner/assets/design-templates/technical-briefing.yaml +96 -0
- package/skills/presentation-planner/assets/scenario-templates/data-report.md +47 -0
- package/skills/presentation-planner/assets/scenario-templates/executive-decision.md +43 -0
- package/skills/presentation-planner/assets/scenario-templates/technical-briefing.md +45 -0
- package/skills/presentation-planner/references/customizing-design-templates.md +160 -0
- package/skills/presentation-planner/references/design-spec-schema.md +72 -0
- package/skills/presentation-planner/references/handoff-contract.md +49 -0
- package/skills/presentation-planner/references/responsibility-boundary.md +32 -0
- package/skills/presentation-planner/references/scenario-templates.md +55 -0
- package/skills/tech-writer/SKILL.md +57 -16
- package/skills/tech-writer/assets/templates/migration-plan.md +173 -0
- package/skills/tech-writer/assets/templates/operations-runbook.md +202 -0
- package/skills/tech-writer/assets/templates/requirements-definition.md +170 -0
- package/skills/tech-writer/assets/templates/rfi.md +113 -0
- package/skills/tech-writer/assets/templates/rfp.md +180 -0
- package/skills/tech-writer/assets/templates/security-design.md +167 -0
- package/skills/tech-writer/assets/templates/system-design.md +220 -0
- package/skills/tech-writer/assets/templates/technical-proposal.md +112 -0
- package/skills/tech-writer/assets/templates/test-plan.md +153 -0
- package/skills/tech-writer/references/doctypes/migration-plan.md +63 -0
- package/skills/tech-writer/references/doctypes/operations-runbook.md +63 -0
- package/skills/tech-writer/references/doctypes/requirements-definition.md +61 -0
- package/skills/tech-writer/references/doctypes/rfi.md +43 -0
- package/skills/tech-writer/references/doctypes/rfp.md +46 -0
- package/skills/tech-writer/references/doctypes/security-design.md +71 -0
- package/skills/tech-writer/references/doctypes/system-design.md +74 -0
- package/skills/tech-writer/references/doctypes/technical-proposal.md +49 -0
- package/skills/tech-writer/references/doctypes/test-plan.md +67 -0
- package/skills/tech-writer/references/style-constitution.md +7 -6
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# <システム名> システム設計書
|
|
2
|
+
|
|
3
|
+
<承認済み要件をどの構成と方式で実現するか、設計の要点と主要な判断を3文以内で要約する。>
|
|
4
|
+
|
|
5
|
+
- 文書版: <例: 1.0>
|
|
6
|
+
- 作成日: <YYYY-MM-DD>
|
|
7
|
+
- 最終更新日: <YYYY-MM-DD>
|
|
8
|
+
- 作成者: <氏名・チーム>
|
|
9
|
+
- レビュー担当: <アーキテクト・開発・運用・セキュリティ担当>
|
|
10
|
+
- ステータス: Draft / In Review / Approved
|
|
11
|
+
- 対象リリース: <バージョン・時期>
|
|
12
|
+
- 対応する要件定義書: <文書名・版・URL>
|
|
13
|
+
|
|
14
|
+
## この設計で合意する事項
|
|
15
|
+
|
|
16
|
+
- 設計対象: <システム・サブシステム・機能>
|
|
17
|
+
- 主要な設計判断: <採用する方式>
|
|
18
|
+
- レビューで確認する事項: <構成、品質属性、運用可能性など>
|
|
19
|
+
|
|
20
|
+
## 設計の前提と対象範囲
|
|
21
|
+
|
|
22
|
+
### 対象範囲
|
|
23
|
+
|
|
24
|
+
- <設計対象のコンポーネント・データ・インターフェース>
|
|
25
|
+
|
|
26
|
+
### 対象外
|
|
27
|
+
|
|
28
|
+
- <別文書・別フェーズで設計する事項>
|
|
29
|
+
|
|
30
|
+
### 前提条件と制約
|
|
31
|
+
|
|
32
|
+
| ID | 区分 | 内容 | 設計への影響 |
|
|
33
|
+
|---|---|---|---|
|
|
34
|
+
| DC-001 | 要件 / 技術 / 予算 / 納期 / 法令 | <条件> | <影響> |
|
|
35
|
+
|
|
36
|
+
## 設計ドライバーと対応要件
|
|
37
|
+
|
|
38
|
+
| 設計ドライバー | 対応要件ID | 優先順位 | 設計上の対応 |
|
|
39
|
+
|---|---|---:|---|
|
|
40
|
+
| <性能・可用性・セキュリティなど> | NFR-001 | 1 | <方式> |
|
|
41
|
+
|
|
42
|
+
## システム全体構成
|
|
43
|
+
|
|
44
|
+
### システムコンテキスト
|
|
45
|
+
|
|
46
|
+
```mermaid
|
|
47
|
+
flowchart LR
|
|
48
|
+
U[<利用者>] --> S[<対象システム>]
|
|
49
|
+
S --> E[<外部システム>]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### コンテナ・実行単位
|
|
53
|
+
|
|
54
|
+
```mermaid
|
|
55
|
+
flowchart LR
|
|
56
|
+
UI[<フロントエンド>] --> API[<API・サービス>]
|
|
57
|
+
API --> DB[(<データストア>)]
|
|
58
|
+
API --> EXT[<外部サービス>]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
| コンポーネント | 責務 | 採用技術 | 実行環境 | 依存先 | 対応要件ID |
|
|
62
|
+
|---|---|---|---|---|---|
|
|
63
|
+
| <名称> | <単一の責務> | <製品・フレームワーク> | <環境> | <依存先> | FR-001 |
|
|
64
|
+
|
|
65
|
+
## コンポーネント設計
|
|
66
|
+
|
|
67
|
+
### <コンポーネント名>
|
|
68
|
+
|
|
69
|
+
- 責務: <担当する処理>
|
|
70
|
+
- 公開インターフェース: <API・イベント・画面>
|
|
71
|
+
- 依存関係: <他コンポーネント・外部サービス>
|
|
72
|
+
- 状態管理: <保持する状態・整合性>
|
|
73
|
+
- エラー処理: <失敗の通知・再試行・補償>
|
|
74
|
+
- 対応要件ID: <FR-001, NFR-001>
|
|
75
|
+
|
|
76
|
+
## 主要な処理フロー
|
|
77
|
+
|
|
78
|
+
### <ユースケース・処理名>
|
|
79
|
+
|
|
80
|
+
```mermaid
|
|
81
|
+
sequenceDiagram
|
|
82
|
+
actor User as <利用者>
|
|
83
|
+
participant App as <アプリケーション>
|
|
84
|
+
participant Store as <データストア>
|
|
85
|
+
User->>App: <要求>
|
|
86
|
+
App->>Store: <読み書き>
|
|
87
|
+
Store-->>App: <結果>
|
|
88
|
+
App-->>User: <応答>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
| ステップ | 処理 | 入出力 | 失敗時の動作 | 対応要件ID |
|
|
92
|
+
|---:|---|---|---|---|
|
|
93
|
+
| 1 | <処理> | <入出力> | <再試行・中断・補償> | FR-001 |
|
|
94
|
+
|
|
95
|
+
## データ設計
|
|
96
|
+
|
|
97
|
+
### データモデル
|
|
98
|
+
|
|
99
|
+
```mermaid
|
|
100
|
+
erDiagram
|
|
101
|
+
ENTITY_A ||--o{ ENTITY_B : has
|
|
102
|
+
ENTITY_A {
|
|
103
|
+
string id PK
|
|
104
|
+
datetime created_at
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
| エンティティ・データ | 用途 | 主キー | 整合性ルール | 機密区分 | 保持・削除 | 対応要件ID |
|
|
109
|
+
|---|---|---|---|---|---|---|
|
|
110
|
+
| <名称> | <用途> | <キー> | <制約> | <区分> | <期間・方法> | DATA-001 |
|
|
111
|
+
|
|
112
|
+
### トランザクションと整合性
|
|
113
|
+
|
|
114
|
+
- トランザクション境界: <開始・確定・取消の単位>
|
|
115
|
+
- 同時実行制御: <ロック・楽観制御・冪等性>
|
|
116
|
+
- 結果整合性: <許容する不整合時間・補正方法>
|
|
117
|
+
|
|
118
|
+
## インターフェース設計
|
|
119
|
+
|
|
120
|
+
| IF-ID | 提供側 / 利用側 | 方式 | エンドポイント・イベント | 入出力 | 認証・認可 | タイムアウト・再試行 | バージョニング |
|
|
121
|
+
|---|---|---|---|---|---|---|---|
|
|
122
|
+
| IF-001 | <提供 / 利用> | REST / Event / File | <名称> | <スキーマ参照> | <方式> | <値・条件> | <方針> |
|
|
123
|
+
|
|
124
|
+
### エラー契約
|
|
125
|
+
|
|
126
|
+
| エラーコード | 発生条件 | 呼び出し元への応答 | 再試行可否 | 運用通知 |
|
|
127
|
+
|---|---|---|---|---|
|
|
128
|
+
| <コード> | <条件> | <ステータス・メッセージ> | Yes / No | <通知条件> |
|
|
129
|
+
|
|
130
|
+
## セキュリティ設計
|
|
131
|
+
|
|
132
|
+
| 項目 | 設計 | 対応する脅威・要件 | 検証方法 |
|
|
133
|
+
|---|---|---|---|
|
|
134
|
+
| 認証 | <方式> | <脅威・NFR-ID> | <試験・監査> |
|
|
135
|
+
| 認可 | <ロール・権限モデル> | <脅威・NFR-ID> | <試験・監査> |
|
|
136
|
+
| データ保護 | <転送時・保存時暗号化、鍵管理> | <データ区分・NFR-ID> | <確認方法> |
|
|
137
|
+
| シークレット管理 | <保管、配布、ローテーション、失効> | <脅威・NFR-ID> | <確認方法> |
|
|
138
|
+
| 監査 | <記録対象、保存期間、改ざん対策> | <規程・NFR-ID> | <確認方法> |
|
|
139
|
+
|
|
140
|
+
## 性能と容量の設計
|
|
141
|
+
|
|
142
|
+
| 指標 | 想定負荷 | 設計目標 | 実現方式 | 限界・スケール条件 | 検証方法 |
|
|
143
|
+
|---|---:|---:|---|---|---|
|
|
144
|
+
| <応答時間・TPSなど> | <値> | <値> | <キャッシュ・並列化など> | <閾値> | <負荷試験> |
|
|
145
|
+
|
|
146
|
+
## 可用性と信頼性の設計
|
|
147
|
+
|
|
148
|
+
- 可用性目標: <SLO・対象時間帯>
|
|
149
|
+
- 障害分離: <冗長化・障害ドメイン>
|
|
150
|
+
- タイムアウトと再試行: <値・バックオフ・上限>
|
|
151
|
+
- 冪等性と重複排除: <方式>
|
|
152
|
+
- RTO / RPO: <値>
|
|
153
|
+
- バックアップ: <対象・頻度・保持期間・復元試験>
|
|
154
|
+
- 災害復旧: <切替方式・責任者・訓練頻度>
|
|
155
|
+
|
|
156
|
+
## 配置とネットワーク設計
|
|
157
|
+
|
|
158
|
+
```mermaid
|
|
159
|
+
flowchart TB
|
|
160
|
+
Client[<クライアント>] --> Edge[<入口・LB・Gateway>]
|
|
161
|
+
Edge --> App[<アプリケーション実行環境>]
|
|
162
|
+
App --> Data[(<データストア>)]
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
| 環境 | リージョン・場所 | ネットワーク境界 | 配置物 | スケール方式 | 構成管理 |
|
|
166
|
+
|---|---|---|---|---|---|
|
|
167
|
+
| Development / Staging / Production | <場所> | <VNet・Subnet・FW> | <構成> | <方式> | <IaC・設定管理> |
|
|
168
|
+
|
|
169
|
+
## 監視と運用の設計
|
|
170
|
+
|
|
171
|
+
| 種別 | 対象 | シグナル | 閾値・条件 | 通知先 | 初動手順 |
|
|
172
|
+
|---|---|---|---|---|---|
|
|
173
|
+
| メトリクス / ログ / トレース | <対象> | <指標> | <条件> | <担当> | <Runbook> |
|
|
174
|
+
|
|
175
|
+
- SLI / SLO: <測定式・目標>
|
|
176
|
+
- ログ方針: <構造、機密情報のマスキング、保持期間>
|
|
177
|
+
- リリース方式: <段階展開、Feature Flag、承認>
|
|
178
|
+
- 定常作業: <バックアップ確認、パッチ、証明書更新>
|
|
179
|
+
- 障害対応: <検知、切り分け、連絡、事後レビュー>
|
|
180
|
+
|
|
181
|
+
## 移行・リリース・ロールバック設計
|
|
182
|
+
|
|
183
|
+
| フェーズ | 作業 | 入力 | 完了条件 | 検証 | ロールバック条件 |
|
|
184
|
+
|---|---|---|---|---|---|
|
|
185
|
+
| <フェーズ> | <作業> | <データ・成果物> | <判定可能な条件> | <方法> | <条件> |
|
|
186
|
+
|
|
187
|
+
- データ移行方式: <全件・差分・二重書きなど>
|
|
188
|
+
- 互換性維持: <API・スキーマ・クライアント>
|
|
189
|
+
- 切替手順: <順序・責任者・所要時間>
|
|
190
|
+
- ロールバック手順: <復旧先・データ整合性の扱い>
|
|
191
|
+
|
|
192
|
+
## テスト方針と要件トレーサビリティ
|
|
193
|
+
|
|
194
|
+
| 要件ID | 設計箇所 | テストレベル | テスト内容 | 合格基準 | 証跡 |
|
|
195
|
+
|---|---|---|---|---|---|
|
|
196
|
+
| FR-001 | <節・コンポーネント> | Unit / Integration / System / Acceptance | <内容> | <基準> | <成果物> |
|
|
197
|
+
|
|
198
|
+
## 採用しなかった方式とトレードオフ
|
|
199
|
+
|
|
200
|
+
| 選択肢 | 評価軸 | 採否 | 理由 | 受け入れる影響 |
|
|
201
|
+
|---|---|---|---|---|
|
|
202
|
+
| <方式> | コスト / 性能 / 運用性 / リスク | 採用 / 不採用 | <理由> | <制約・負債> |
|
|
203
|
+
|
|
204
|
+
## リスクと未解決事項
|
|
205
|
+
|
|
206
|
+
| ID | 区分 | 内容 | 影響 | 対応・決定期限 | 所有者 | ステータス |
|
|
207
|
+
|---|---|---|---|---|---|---|
|
|
208
|
+
| RSK-001 | リスク / 未解決事項 | <内容> | <影響> | <対応・期限> | <担当> | Open |
|
|
209
|
+
|
|
210
|
+
## レビューと承認記録
|
|
211
|
+
|
|
212
|
+
| 版 | レビュー・承認日 | 担当 | 判断 | 条件・コメント |
|
|
213
|
+
|---|---|---|---|---|
|
|
214
|
+
| <版> | <YYYY-MM-DD> | <氏名・会議体> | Approved / Rejected / Deferred | <条件> |
|
|
215
|
+
|
|
216
|
+
## 変更履歴
|
|
217
|
+
|
|
218
|
+
| 版 | 日付 | 変更内容 | 変更理由 | 作成者 |
|
|
219
|
+
|---|---|---|---|---|
|
|
220
|
+
| 0.1 | <YYYY-MM-DD> | 初版 | <理由> | <氏名> |
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# <提案名>
|
|
2
|
+
|
|
3
|
+
<解決する課題、提案内容、期待する成果を3文以内で要約する。>
|
|
4
|
+
|
|
5
|
+
- 提案者: <氏名・チーム>
|
|
6
|
+
- 提案日: <YYYY-MM-DD>
|
|
7
|
+
- 対象読者: <意思決定者・レビュー担当者>
|
|
8
|
+
- ステータス: Draft / In Review / Approved / Rejected
|
|
9
|
+
- 承認を求める事項: <承認・却下してほしい判断>
|
|
10
|
+
|
|
11
|
+
## <この提案が必要な背景>
|
|
12
|
+
|
|
13
|
+
<現在の状況、観測された問題、今対応する理由を事実ベースで記載する。>
|
|
14
|
+
|
|
15
|
+
## 達成する目標と対象外
|
|
16
|
+
|
|
17
|
+
### 目標
|
|
18
|
+
|
|
19
|
+
- <測定可能な目標>
|
|
20
|
+
- <利用者または事業にもたらす成果>
|
|
21
|
+
|
|
22
|
+
### 対象外
|
|
23
|
+
|
|
24
|
+
- <今回の提案では扱わない事項>
|
|
25
|
+
|
|
26
|
+
## 提案する技術的アプローチ
|
|
27
|
+
|
|
28
|
+
<採用する方式を最初の1文で明示し、その後に構成と処理の流れを説明する。>
|
|
29
|
+
|
|
30
|
+
```mermaid
|
|
31
|
+
flowchart LR
|
|
32
|
+
A[<入力>] --> B[<主要コンポーネント>]
|
|
33
|
+
B --> C[<出力>]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 主要コンポーネント
|
|
37
|
+
|
|
38
|
+
| コンポーネント | 役割 | 採用技術 | 選定理由 |
|
|
39
|
+
|---|---|---|---|
|
|
40
|
+
| <名称> | <役割> | <製品・サービス> | <理由> |
|
|
41
|
+
|
|
42
|
+
### データとインターフェース
|
|
43
|
+
|
|
44
|
+
- 入力データ: <形式・取得元>
|
|
45
|
+
- 出力データ: <形式・保存先>
|
|
46
|
+
- 外部連携: <API・プロトコル・認証方式>
|
|
47
|
+
|
|
48
|
+
## セキュリティとコンプライアンス
|
|
49
|
+
|
|
50
|
+
- 認証・認可: <方式と権限モデル>
|
|
51
|
+
- データ保護: <暗号化・保持期間・削除方法>
|
|
52
|
+
- 監査: <ログ・追跡方法>
|
|
53
|
+
- 適用基準: <法令・社内規程・認証>
|
|
54
|
+
|
|
55
|
+
## 実施計画
|
|
56
|
+
|
|
57
|
+
| フェーズ | 作業 | 成果物 | 完了条件 | 期間 |
|
|
58
|
+
|---|---|---|---|---|
|
|
59
|
+
| <フェーズ名> | <作業内容> | <成果物> | <確認可能な条件> | <期間> |
|
|
60
|
+
|
|
61
|
+
### ロールアウトとロールバック
|
|
62
|
+
|
|
63
|
+
- ロールアウト: <段階導入・移行方法>
|
|
64
|
+
- ロールバック条件: <中止を判断する指標>
|
|
65
|
+
- ロールバック手順: <元の状態へ戻す方法>
|
|
66
|
+
|
|
67
|
+
## 必要な費用と体制
|
|
68
|
+
|
|
69
|
+
- TCO評価期間: <例: 導入から5年間>
|
|
70
|
+
- 通貨・税区分: <通貨・税込/税別>
|
|
71
|
+
|
|
72
|
+
| 項目 | 初期費用 | 年間継続費用 | 評価期間TCO | 前提条件 | 必要な担当・工数 |
|
|
73
|
+
|---|---:|---:|---:|---|---|
|
|
74
|
+
| <項目> | <金額> | <年額> | <金額> | <条件> | <役割・人日> |
|
|
75
|
+
| **合計** | **<合計>** | **<合計>** | **<初期費用+評価期間の継続費用>** | | |
|
|
76
|
+
|
|
77
|
+
## 共通の評価軸で代替案を比較する
|
|
78
|
+
|
|
79
|
+
| 選択肢 | 評価期間TCO | 導入期間 | 実装・運用工数 | リスク | 採否と理由 |
|
|
80
|
+
|---|---:|---|---|---|---|
|
|
81
|
+
| 現状維持 | <金額> | なし | <工数> | <継続する課題> | 不採用 / 採用: <理由> |
|
|
82
|
+
| 提案方式 | <金額> | <期間> | <工数> | <リスク> | 採用 / 不採用: <理由> |
|
|
83
|
+
| <代替案> | <金額> | <期間> | <工数> | <リスク> | 採用 / 不採用: <理由> |
|
|
84
|
+
|
|
85
|
+
## リスクと対策
|
|
86
|
+
|
|
87
|
+
| リスク | 影響 | 発生可能性 | 対策 | 所有者 |
|
|
88
|
+
|---|---|---|---|---|
|
|
89
|
+
| <リスク> | High / Medium / Low | High / Medium / Low | <予防・軽減策> | <担当> |
|
|
90
|
+
|
|
91
|
+
## 成功を判断する指標
|
|
92
|
+
|
|
93
|
+
| 指標 | 現状値 | 目標値 | 測定方法 | 判定時期 | 未達時の対応 |
|
|
94
|
+
|---|---:|---:|---|---|---|
|
|
95
|
+
| <指標> | <値> | <値> | <方法> | <日付・時点> | <改善・縮小・撤退判断> |
|
|
96
|
+
|
|
97
|
+
## 意思決定事項と未解決事項
|
|
98
|
+
|
|
99
|
+
### 承認条件の補足
|
|
100
|
+
|
|
101
|
+
<ヘッダーの「承認を求める事項」は繰り返さず、条件付き承認に必要な補足だけを記載する。>
|
|
102
|
+
|
|
103
|
+
### 未解決事項
|
|
104
|
+
|
|
105
|
+
- <追加調査または合意が必要な事項>
|
|
106
|
+
|
|
107
|
+
### 決定記録
|
|
108
|
+
|
|
109
|
+
- 決定: Approved / Rejected / Deferred
|
|
110
|
+
- 決定者: <氏名・会議体>
|
|
111
|
+
- 決定日: <YYYY-MM-DD>
|
|
112
|
+
- 条件・コメント: <承認条件または却下理由>
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# <システム・プロジェクト名> テスト計画書
|
|
2
|
+
|
|
3
|
+
<何を、どの品質リスクに対して、どの基準で検証する計画かを3文以内で要約する。>
|
|
4
|
+
|
|
5
|
+
- 文書版: <例: 1.0>
|
|
6
|
+
- 作成日: <YYYY-MM-DD>
|
|
7
|
+
- 最終更新日: <YYYY-MM-DD>
|
|
8
|
+
- 作成者: <氏名・チーム>
|
|
9
|
+
- 承認者: <氏名・会議体>
|
|
10
|
+
- ステータス: Draft / In Review / Approved
|
|
11
|
+
- 対象リリース: <バージョン・時期>
|
|
12
|
+
- 要件ベースライン: <要件定義書の文書名・版・URL>
|
|
13
|
+
- 設計ベースライン: <設計書の文書名・版・URL>
|
|
14
|
+
- セキュリティ設計ベースライン: <セキュリティ設計書の文書名・版・URL / N/A>
|
|
15
|
+
|
|
16
|
+
## このテスト計画で合意する事項
|
|
17
|
+
|
|
18
|
+
- テスト対象と対象外: <システム・機能・品質特性>
|
|
19
|
+
- 合否判定基準: <リリース可否を決める基準>
|
|
20
|
+
- 承認を求める事項: <範囲、環境、日程、体制、残余リスク>
|
|
21
|
+
|
|
22
|
+
## テストの目的と品質目標
|
|
23
|
+
|
|
24
|
+
| 目的ID | 品質目標 | 対応要件ID | 測定指標 | 合格値 |
|
|
25
|
+
|---|---|---|---|---:|
|
|
26
|
+
| T-OBJ-001 | <検証する品質> | FR-001 / NFR-001 | <指標> | <値> |
|
|
27
|
+
|
|
28
|
+
## 対象範囲と対象外
|
|
29
|
+
|
|
30
|
+
### 対象範囲
|
|
31
|
+
|
|
32
|
+
- <対象機能・コンポーネント・インターフェース>
|
|
33
|
+
- <対象ブラウザー・端末・OS・環境>
|
|
34
|
+
|
|
35
|
+
### 対象外
|
|
36
|
+
|
|
37
|
+
- <今回実施しない試験>
|
|
38
|
+
- <別チーム・別フェーズが担当する試験>
|
|
39
|
+
|
|
40
|
+
## 品質リスク
|
|
41
|
+
|
|
42
|
+
| リスクID | 想定する障害・品質リスク | 影響 | 発生可能性 | 検出するテスト | 優先度 |
|
|
43
|
+
|---|---|---|---|---|---|
|
|
44
|
+
| QR-001 | <リスク> | High / Medium / Low | High / Medium / Low | <テスト種別> | <順位> |
|
|
45
|
+
|
|
46
|
+
## テスト戦略
|
|
47
|
+
|
|
48
|
+
| テストレベル・種別 | 目的 | 対象 | 実施者 | 自動化方針 | 完了条件 |
|
|
49
|
+
|---|---|---|---|---|---|
|
|
50
|
+
| 単体テスト | <目的> | <対象> | <担当> | <範囲・ツール> | <条件> |
|
|
51
|
+
| 結合テスト | <目的> | <対象> | <担当> | <範囲・ツール> | <条件> |
|
|
52
|
+
| システムテスト | <目的> | <対象> | <担当> | <範囲・ツール> | <条件> |
|
|
53
|
+
| 受入テスト | <目的> | <対象> | <判定者> | <範囲・ツール> | <条件> |
|
|
54
|
+
|
|
55
|
+
### 非機能テスト
|
|
56
|
+
|
|
57
|
+
| 種別 | 対応要件ID | 条件・負荷 | 測定項目 | 合格基準 | 実施方法 |
|
|
58
|
+
|---|---|---|---|---|---|
|
|
59
|
+
| 性能・容量 | NFR-001 | <同時数・データ量> | <応答時間・TPS> | <値> | <方法・ツール> |
|
|
60
|
+
| 可用性・復旧 | NFR-002 | <障害条件> | <RTO・RPO> | <値> | <方法> |
|
|
61
|
+
| セキュリティ | NFR-003 | <脅威・権限> | <検証項目> | <基準> | <診断・試験> |
|
|
62
|
+
|
|
63
|
+
## テスト環境
|
|
64
|
+
|
|
65
|
+
| 環境 | 用途 | 構成 | 本番との差分 | 利用期間 | 管理者 |
|
|
66
|
+
|---|---|---|---|---|---|
|
|
67
|
+
| <環境名> | <用途> | <アプリ・基盤・外部接続> | <差分と影響> | <期間> | <担当> |
|
|
68
|
+
|
|
69
|
+
### 環境の準備条件
|
|
70
|
+
|
|
71
|
+
- ビルド・構成版: <バージョン・コミット>
|
|
72
|
+
- 外部サービス: <実接続 / Stub / Mock>
|
|
73
|
+
- 監視・ログ: <取得方法・保存先>
|
|
74
|
+
- リセット方法: <初期化・再作成手順>
|
|
75
|
+
|
|
76
|
+
## テストデータ
|
|
77
|
+
|
|
78
|
+
| データセット | 用途 | 作成・取得方法 | 機密区分 | マスキング | 初期化・削除 |
|
|
79
|
+
|---|---|---|---|---|---|
|
|
80
|
+
| <名称> | <テスト目的> | <生成・複製> | <区分> | <方法> | <方法> |
|
|
81
|
+
|
|
82
|
+
## 開始条件と終了条件
|
|
83
|
+
|
|
84
|
+
### 開始条件
|
|
85
|
+
|
|
86
|
+
- <対象ビルドが配置済み>
|
|
87
|
+
- <環境・データ・アカウントが準備済み>
|
|
88
|
+
- <重大な前工程不具合が解消済み>
|
|
89
|
+
|
|
90
|
+
### 終了条件
|
|
91
|
+
|
|
92
|
+
| 判定項目 | 合格条件 | 証跡 | 判定者 |
|
|
93
|
+
|---|---|---|---|
|
|
94
|
+
| テスト実行 | <必須ケース実行率など> | <レポート> | <役割> |
|
|
95
|
+
| 不具合 | <重大度別の残存許容数> | <一覧> | <役割> |
|
|
96
|
+
| 要件網羅 | <Must要件100%など> | <トレーサビリティ表> | <役割> |
|
|
97
|
+
| 残余リスク | <受容条件> | <承認記録> | <役割> |
|
|
98
|
+
|
|
99
|
+
### 中断条件と再開条件
|
|
100
|
+
|
|
101
|
+
| 中断条件 | 判断者 | 必要な対応 | 再開条件 | 再開承認者 |
|
|
102
|
+
|---|---|---|---|---|
|
|
103
|
+
| <環境障害、重大不具合、前提崩れなど> | <役割> | <修正・再構築・影響分析> | <環境確認、修正版配置、再テスト範囲の合意> | <役割> |
|
|
104
|
+
|
|
105
|
+
## テストケースと要件トレーサビリティ
|
|
106
|
+
|
|
107
|
+
| テストID | 対応要件ID | 対応セキュリティ試験ID | 対応脅威ID | 対応制御ID | シナリオ | 事前条件 | 操作・入力 | 期待結果 | 優先度 | 自動化 |
|
|
108
|
+
|---|---|---|---|---|---|---|---|---|---|---|
|
|
109
|
+
| TC-001 | FR-001 / AC-001 | SEC-TC-001 / N/A | THR-001 / N/A | CTRL-001 / N/A | <シナリオ> | <条件> | <操作> | <観測可能な結果> | Must | Yes / No |
|
|
110
|
+
|
|
111
|
+
## 不具合管理
|
|
112
|
+
|
|
113
|
+
| 重大度 | 定義 | 初動期限 | 修正・判断期限 | リリース判定 |
|
|
114
|
+
|---|---|---|---|---|
|
|
115
|
+
| Critical | <サービス停止・情報漏えいなど> | <時間> | <期限> | 原則不可 |
|
|
116
|
+
| High | <主要機能が利用不能など> | <時間> | <期限> | <例外承認条件> |
|
|
117
|
+
| Medium / Low | <影響> | <時間> | <期限> | <許容条件> |
|
|
118
|
+
|
|
119
|
+
- 登録先: <Issue tracker>
|
|
120
|
+
- 必須情報: <再現手順、期待結果、実結果、環境、証跡>
|
|
121
|
+
- 再テスト: <修正確認と回帰テストの範囲>
|
|
122
|
+
- 重複・却下・延期: <判断権限と記録方法>
|
|
123
|
+
|
|
124
|
+
## スケジュールと体制
|
|
125
|
+
|
|
126
|
+
| フェーズ | 作業 | 期間 | 担当 | 入力 | 成果物 |
|
|
127
|
+
|---|---|---|---|---|---|
|
|
128
|
+
| <フェーズ> | <作業> | <期間> | <担当> | <入力> | <レポート・証跡> |
|
|
129
|
+
|
|
130
|
+
## テスト結果と証跡
|
|
131
|
+
|
|
132
|
+
- 実行結果の保存先: <URL・リポジトリ>
|
|
133
|
+
- ログ・画面・計測値の保存方法: <方法>
|
|
134
|
+
- テストサマリーの更新頻度: <日次・フェーズ終了時>
|
|
135
|
+
- 最終報告の内容: <実行数、成功率、不具合、残余リスク>
|
|
136
|
+
|
|
137
|
+
## リスクと未解決事項
|
|
138
|
+
|
|
139
|
+
| ID | 内容 | 影響 | 対応・期限 | 所有者 | ステータス |
|
|
140
|
+
|---|---|---|---|---|---|
|
|
141
|
+
| T-RSK-001 | <環境遅延・データ不足など> | <影響> | <対応> | <担当> | Open |
|
|
142
|
+
|
|
143
|
+
## 承認記録
|
|
144
|
+
|
|
145
|
+
| 版 | 承認日 | 承認者 | 判断 | 残余リスク・条件 |
|
|
146
|
+
|---|---|---|---|---|
|
|
147
|
+
| <版> | <YYYY-MM-DD> | <氏名・会議体> | Approved / Rejected / Deferred | <条件> |
|
|
148
|
+
|
|
149
|
+
## 変更履歴
|
|
150
|
+
|
|
151
|
+
| 版 | 日付 | 変更内容 | 変更理由 | 作成者 |
|
|
152
|
+
|---|---|---|---|---|
|
|
153
|
+
| 0.1 | <YYYY-MM-DD> | 初版 | <理由> | <氏名> |
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Migration plan type
|
|
2
|
+
|
|
3
|
+
A migration plan defines how data, users, integrations, and business
|
|
4
|
+
processes move from a current state to a target state with measurable
|
|
5
|
+
validation, controlled downtime, and a tested rollback path.
|
|
6
|
+
|
|
7
|
+
## Target reader
|
|
8
|
+
|
|
9
|
+
Migration leads, application and data engineers, business owners, operators,
|
|
10
|
+
support teams, security reviewers, and Go/No-Go approvers.
|
|
11
|
+
|
|
12
|
+
## Settle before writing
|
|
13
|
+
|
|
14
|
+
- The current and target states and complete migration inventory
|
|
15
|
+
- Allowed downtime, data-loss tolerance, and business continuity needs
|
|
16
|
+
- Migration approach, waves, dependencies, and change-freeze conditions
|
|
17
|
+
- Reconciliation and business-acceptance criteria
|
|
18
|
+
- Go/No-Go and rollback authority, triggers, and deadlines
|
|
19
|
+
- Rehearsal evidence, communication needs, and post-migration support
|
|
20
|
+
|
|
21
|
+
## Responsibility boundary
|
|
22
|
+
|
|
23
|
+
Own the executable transition plan and its decisions. Link to implementation
|
|
24
|
+
scripts rather than embedding large programs. Do not claim rollback is
|
|
25
|
+
possible unless the plan states how post-cutover writes and data consistency
|
|
26
|
+
will be handled.
|
|
27
|
+
|
|
28
|
+
The migration section in `system-design` is sufficient for describing the
|
|
29
|
+
chosen transition architecture. Use a standalone `migration-plan` when the
|
|
30
|
+
cutover needs rehearsals, a timed procedure, business communications,
|
|
31
|
+
Go/No-Go gates, reconciliation evidence, or separate approval. When both
|
|
32
|
+
exist, the migration plan is authoritative for execution and the system
|
|
33
|
+
design summarizes the strategy and links to it.
|
|
34
|
+
|
|
35
|
+
## Template
|
|
36
|
+
|
|
37
|
+
Start from `assets/templates/migration-plan.md`.
|
|
38
|
+
The template is the Japanese-language skeleton; translate its headings when
|
|
39
|
+
the target document is English.
|
|
40
|
+
|
|
41
|
+
## Recommended skeleton
|
|
42
|
+
|
|
43
|
+
1. Agreement target, current and target states, scope, and constraints
|
|
44
|
+
2. Inventory, dependencies, mappings, transformation, and migration method
|
|
45
|
+
3. Roles, rehearsals, readiness, and timed production procedure
|
|
46
|
+
4. Reconciliation, Go/No-Go gates, rollback, and business continuity
|
|
47
|
+
5. Security, communication, stabilization, decommissioning, and approval
|
|
48
|
+
|
|
49
|
+
## Checklist
|
|
50
|
+
|
|
51
|
+
- [ ] Are all data, configuration, identities, integrations, and business
|
|
52
|
+
processes inventoried with owners and dependencies?
|
|
53
|
+
- [ ] Are mapping, transformation, default, rejection, retry, and idempotency
|
|
54
|
+
rules explicit?
|
|
55
|
+
- [ ] Have full-scale timing, validation, and rollback been rehearsed?
|
|
56
|
+
- [ ] Are start, cutover, reopen, Go/No-Go, and rollback conditions objective?
|
|
57
|
+
- [ ] Do reconciliation checks cover counts, aggregates, referential
|
|
58
|
+
integrity, and business scenarios?
|
|
59
|
+
- [ ] Does rollback address writes made after cutover and its last safe time?
|
|
60
|
+
- [ ] Are downtime communications, alternative operations, support, security,
|
|
61
|
+
temporary access, and evidence covered?
|
|
62
|
+
- [ ] Are stabilization, cleanup, old-system retention, and decommissioning
|
|
63
|
+
conditions defined?
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Operations design and runbook type
|
|
2
|
+
|
|
3
|
+
An operations design and runbook makes a production service observable,
|
|
4
|
+
changeable, recoverable, and supportable. It combines stable operating
|
|
5
|
+
policies with executable procedures for routine work and incidents.
|
|
6
|
+
|
|
7
|
+
## Target reader
|
|
8
|
+
|
|
9
|
+
Service owners, on-call engineers, operators, support staff, security teams,
|
|
10
|
+
change approvers, and incident commanders.
|
|
11
|
+
|
|
12
|
+
## Settle before writing
|
|
13
|
+
|
|
14
|
+
- The service boundary, owners, dependencies, and operating hours
|
|
15
|
+
- SLI, SLO, alert, capacity, backup, RTO, and RPO targets
|
|
16
|
+
- On-call, escalation, change, and incident authority
|
|
17
|
+
- Access requirements and safety constraints for operational actions
|
|
18
|
+
- The symptoms and failure scenarios that require executable runbooks
|
|
19
|
+
- Review, exercise, and expiration frequency
|
|
20
|
+
|
|
21
|
+
## Responsibility boundary
|
|
22
|
+
|
|
23
|
+
Write steps that an authorized operator can execute and verify. Link to
|
|
24
|
+
automation where it exists, but preserve preconditions, safety checks,
|
|
25
|
+
expected results, escalation, and recovery behavior. Never include secret
|
|
26
|
+
values or bypass access and change controls.
|
|
27
|
+
|
|
28
|
+
The operations section in `system-design` is sufficient for architectural
|
|
29
|
+
operability decisions. Use a standalone `operations-runbook` when on-call
|
|
30
|
+
staff need executable procedures, alerts, escalation, exercises, or a review
|
|
31
|
+
cycle independent of the system design. When both exist, the runbook is
|
|
32
|
+
authoritative for live operations and the system design links to its current
|
|
33
|
+
approved version.
|
|
34
|
+
|
|
35
|
+
## Template
|
|
36
|
+
|
|
37
|
+
Start from `assets/templates/operations-runbook.md`.
|
|
38
|
+
The template is the Japanese-language skeleton; translate its headings when
|
|
39
|
+
the target document is English.
|
|
40
|
+
|
|
41
|
+
## Recommended skeleton
|
|
42
|
+
|
|
43
|
+
1. Service scope, dependencies, levels, owners, and escalation
|
|
44
|
+
2. Observability, alerts, routine work, and capacity management
|
|
45
|
+
3. Incident severity, common initial response, and symptom runbooks
|
|
46
|
+
4. Start, stop, restore, security, change, and rollback procedures
|
|
47
|
+
5. Disaster recovery, business continuity, risks, exercises, and review
|
|
48
|
+
|
|
49
|
+
## Checklist
|
|
50
|
+
|
|
51
|
+
- [ ] Can an unfamiliar authorized operator identify the service, owner,
|
|
52
|
+
dependencies, dashboards, communication channels, and impact?
|
|
53
|
+
- [ ] Are SLI/SLO calculations, alert conditions, suppression, and test
|
|
54
|
+
frequency specified?
|
|
55
|
+
- [ ] Does every procedure state preconditions, safety limits, steps,
|
|
56
|
+
expected results, evidence, escalation, and recovery?
|
|
57
|
+
- [ ] Are backup restoration, RTO/RPO, disaster recovery, and exercises
|
|
58
|
+
executable and owned?
|
|
59
|
+
- [ ] Are access, secret, certificate, vulnerability, audit, and security
|
|
60
|
+
incident operations covered without exposing secret values?
|
|
61
|
+
- [ ] Are releases, emergency changes, rollback, and post-change checks clear?
|
|
62
|
+
- [ ] Are capacity, cost, routine maintenance, review dates, and stale
|
|
63
|
+
runbook detection addressed?
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Requirements definition type
|
|
2
|
+
|
|
3
|
+
A requirements definition establishes agreement on what outcomes, scope,
|
|
4
|
+
capabilities, quality levels, and acceptance conditions a system must
|
|
5
|
+
satisfy. It describes the required behavior and measurable constraints
|
|
6
|
+
without prematurely prescribing the implementation architecture.
|
|
7
|
+
|
|
8
|
+
## Target reader
|
|
9
|
+
|
|
10
|
+
Business owners, product owners, users, architects, delivery teams,
|
|
11
|
+
operators, security reviewers, and approvers who must agree on what will be
|
|
12
|
+
built and how acceptance will be judged.
|
|
13
|
+
|
|
14
|
+
## Settle before writing
|
|
15
|
+
|
|
16
|
+
- The business problem, target users, and measurable outcome
|
|
17
|
+
- In-scope and out-of-scope business processes, systems, and data
|
|
18
|
+
- Requirement priorities and the authority that resolves conflicts
|
|
19
|
+
- Constraints covering budget, schedule, law, policy, and existing systems
|
|
20
|
+
- Measurable acceptance conditions for functional and non-functional needs
|
|
21
|
+
- The identifier or naming convention used for traceability
|
|
22
|
+
|
|
23
|
+
## Responsibility boundary
|
|
24
|
+
|
|
25
|
+
State what the system must achieve and the constraints it must meet. Do not
|
|
26
|
+
turn preferred products, component layouts, database schemas, or deployment
|
|
27
|
+
topologies into requirements unless they are genuine externally imposed
|
|
28
|
+
constraints. Put implementation choices in a system design document and
|
|
29
|
+
link them back to requirement IDs.
|
|
30
|
+
|
|
31
|
+
## Template
|
|
32
|
+
|
|
33
|
+
Start from `assets/templates/requirements-definition.md`.
|
|
34
|
+
The template is the Japanese-language skeleton; translate its headings when
|
|
35
|
+
the target document is English.
|
|
36
|
+
|
|
37
|
+
## Recommended skeleton
|
|
38
|
+
|
|
39
|
+
1. Agreement target, background, problem, purpose, and success measures
|
|
40
|
+
2. Scope, stakeholders, assumptions, and constraints
|
|
41
|
+
3. Business flow, business rules, and prioritized functional requirements
|
|
42
|
+
4. Measurable non-functional, data, and external-interface requirements
|
|
43
|
+
5. Migration, operation, acceptance, and traceability
|
|
44
|
+
6. Risks, open questions, approval, and change history
|
|
45
|
+
|
|
46
|
+
## Checklist
|
|
47
|
+
|
|
48
|
+
- [ ] Are purpose, scope, exclusions, stakeholders, assumptions, and
|
|
49
|
+
constraints explicit?
|
|
50
|
+
- [ ] Does every requirement have a stable ID, priority, and independently
|
|
51
|
+
verifiable acceptance condition?
|
|
52
|
+
- [ ] Are non-functional requirements measurable under stated conditions?
|
|
53
|
+
- [ ] Are data ownership, classification, retention, quality, and deletion
|
|
54
|
+
requirements covered?
|
|
55
|
+
- [ ] Are external interfaces, migration, operations, and failure handling
|
|
56
|
+
included where applicable?
|
|
57
|
+
- [ ] Can each requirement be traced to a problem or objective and forward
|
|
58
|
+
to an acceptance test and design or implementation artifact?
|
|
59
|
+
- [ ] Are implementation preferences separated from actual constraints?
|
|
60
|
+
- [ ] Are unresolved items owned and time-bound, with approval and change
|
|
61
|
+
history recorded?
|