| name | teams-docs-operations |
| description | Generate Operations phase documents (SLO/SLA definitions, performance test records, operational runbooks) in the teams/ directory. Phase 4 of the /start-teams-doc workflow. Requires QA phase approval. Use when defining SLO/SLA, creating runbooks, or documenting operational procedures. |
Teams Docs — Operations スキル
トリガー条件
/teams-docs-operations コマンドが呼ばれたとき
/start-teams-doc の第4フェーズ(operation フェーズ)として呼ばれたとき
- ユーザーが「SLO/SLA を定義したい」「運用ドキュメントを作りたい」「Runbook を作りたい」と言ったとき
入力パラメータ
/start-teams-doc から以下が引き渡される:
docs_root: ドキュメントルートパス(sdd-docs または .)
team, project, feature, feature_id, goal, scope_in, scope_out
- 任意:
constraints
実行前チェック
{docs_root}/teams/{team}/{project}/{feature}/_approval-status.yaml を読み込む
qa.status != approved の場合は停止して QA フェーズの承認を促す
operation.status == changes_requested の場合は修正モードで実行
operation.status == in_review の場合はドキュメント生成をスキップし、構造バリデーションのみ再実行して承認確認メッセージに直接進む
手順
1. ディレクトリ準備
{docs_root}/teams/{team}/{project}/{feature}/operation/
├── slo-sla.md (必須)
├── パフォーマンステスト記録.md (任意)
└── 運用手法.md (任意)
任意ファイルを作成しない場合は operation/README.md にその理由を記載する。
2. slo-sla.md 生成(必須)
- テンプレート: assets/slo-sla-template.md
- design/非機能要件.md の指標を参照して SLI/SLO を定義
- 各 SLO に数値目標・計測ウィンドウ・アラート閾値を設定
- 監視・アラートと対応手順の対応表を記入
- OPS ID を
OPS-{feature_id}-NNN 形式で採番
3. 運用手法.md 生成(バッチ処理・定期運用がある場合)
4. パフォーマンステスト記録.md 生成(負荷試験を実施した場合)
5. Traceability Matrix 更新
slo-sla.md 末尾の Matrix に NFR(SPEC)→OPS の対応を記入する。
品質ゲート(承認前チェック)
references/quality-checklist.md の全項目を確認する。
SLO 指標と非機能要件の数値が一致していない場合は承認不可。
バリデーションスクリプトを実行して自動チェックを行う:
python <this_skill_dir>/scripts/validate.py <feature_dir>
<this_skill_dir> は、この SKILL.md が配置されているディレクトリの実際のパスに解決すること。
エラーが出た場合は修正してから承認確認を行う。
承認確認メッセージ
品質ゲート通過後、承認確認メッセージを表示する前に _approval-status.yaml の operation.status を in_review に更新する。
これにより、ユーザーが承認確認中にセッションを中断しても、次回再開時にドキュメント生成をスキップできる。
✅ [operation] フェーズの品質ゲートを通過しました。
承認しますか?
1. Approve & Continue(_approval-status.yaml を更新して全フェーズ完了)
2. Request Changes(修正点を確認して停止)
3. Pause Review(レビューを中断して後で再開)
承認時: _approval-status.yaml の operation.status を approved、approved_at を本日付で更新する。
修正要求時: _approval-status.yaml の operation.status を changes_requested に更新し、ユーザーが指摘した修正点の一覧を表示して停止する。
レビュー中断時: status は in_review のまま維持。以下を表示して停止する:
⏸️ [operation] フェーズのレビューを中断しました。
`/start-teams-doc` で再開できます。
出力ファイル一覧
| ファイル | 必須 |
|---|
operation/slo-sla.md | ✅ |
operation/運用手法.md | 任意(なければ README に理由を記載) |
operation/パフォーマンステスト記録.md | 任意(なければ README に理由を記載) |
ソースコード参照
サブモジュールモード(docs_root = sdd-docs)の場合、ワークスペースルートにメインリポジトリのソースコードが存在する。以下を積極的に参照してドキュメントの精度を高めること:
- インフラ構成(Dockerfile, docker-compose, k8s manifests 等)→ SLO/SLA の計測方法に反映
- 監視・アラート設定(Datadog, CloudWatch 等)→ 運用手法に反映
- CI/CD パイプライン・デプロイスクリプト → デプロイ手順に反映
Troubleshooting
- SLO/NFR 整合性警告が出る →
design/非機能要件.md と operation/slo-sla.md の数値指標(%、ms、秒等)を突き合わせる。SLO 目標値は非機能要件の指標と一致させる。
- 運用手法.md が不要な場合 →
operation/README.md を作成し、不要と判断した理由(バッチ処理なし、定期運用なし等)を記載する。
- エスカレーション先が未記載 → 障害対応手順の各パターンにエスカレーション先(Slack チャンネル・担当者・連絡手段)を追加する。
参照