docs-decommission について
docs-decommissionは、サービスを廃止するチーム向けのドキュメント作成スキルです。インフラ、データ、セキュリティ、依存関係、費用、ロールバックを網羅するサービス別チェックリストを作成します。
主な機能
- 01サービス概要と連絡先
- 02インフラとデータのチェックリスト
- 03セキュリティとネットワークの整理手順
- 04依存関係と監視の確認
- 05費用と最終確認の手順
- 06ロールバックと承認の記録
活用シーン
- 01デプロイ時の廃止ドキュメント準備
- 02チーム横断のサービス廃止調整
- 03リソース削除とデータ保持の追跡
- 04ロールバックと最終承認の記録
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ laurigates/ claude-plugins --skill docs-decommissionインストール後、Claude Code で/docs-decommissionを入力して読み込まれたか確認します。
詳細
サービス廃止ドキュメントジェネレーター
このスキルを使う場面
| 次の場合はこのスキルを使います… | 次の場合は docs-generate を使います… |
|---|---|
| デプロイ済みサービスを廃止または停止する際に、完全な撤去チェックリストが必要な場合 | コードアノテーションから API リファレンス、README、CHANGELOG の内容を作成する場合 |
| デプロイ時に、状況を把握しているうちにインフラ、DNS、シークレット、請求のクリーンアップ手順を記録する場合 | 開発と並行して保守する一般的なプロジェクトドキュメントを作成する場合 |
環境、関係者、ロールバック手順を含む、サービス固有の DECOMMISSION-<service>.md を生成する場合 | 既存のドキュメントを現在のコードベースと同期する場合(docs-sync を使います) |
${1:-[SERVICE_NAME]} の包括的な廃止チェックリストを、状況を把握しているデプロイ時に作成します。
タスク
以下を含む、詳細な廃止ドキュメントファイルを作成します。
1. サービス概要
- サービス名、目的、デプロイ日を記録します
- すべての環境(dev、staging、production)を列挙します
- 主な関係者とチームの連絡先を記載します
- リポジトリとデプロイ先を記録します
2. インフラリソースのチェックリスト
以下を含むチェックリストを作成します。
- クラウドリソース(コンピュートインスタンス、コンテナー、サーバーレス関数)
- ストレージリソース(データベース、オブジェクトストレージ、ファイルシステム、ボリューム)
- ネットワークリソース(ロードバランサー、DNS レコード、CDN 設定)
- セキュリティリソース(SSL 証明書、API キー、サービスアカウント、IAM ロール)
- 監視とアラート(ダッシュボード、アラートルール、ログ集約)
- CI/CD パイプラインと自動化ジョブ
- スケジュールタスクと cron ジョブ
3. データ管理のチェックリスト
- すべてのデータストアとその場所を特定します
- データのバックアップ手順と保持ポリシーを作成します
- データの移行またはアーカイブ要件を記録します
- ポリシーに準拠したデータ削除を計画します
- バックアップの完了と整合性を確認します
- 法務/コンプライアンス上のデータ保持要件を記録します
4. アクセスとセキュリティのチェックリスト
- サービスアカウントと API 認証情報を無効化します
- IAM ロールと権限を削除します
- 共有シークレットまたはキーをローテーションします
- セキュリティグループとファイアウォールルールを更新します
- OAuth アプリケーションと連携を削除します
- ユーザーアクセスを監査し、削除します
- パスワード保管庫とシークレットマネージャーを更新します
5. DNS とネットワークのチェックリスト
- すべての DNS レコード(A、CNAME、TXT、MX など)を記録します
- DNS レコードの削除または更新を計画します
- ロードバランサーの設定を更新します
- CDN の設定を削除または更新します
- ハードコードされた URL またはエンドポイントを記録します
- エンドポイントの変更を依存サービスに通知します
6. 連携と依存関係のチェックリスト
- すべての上流サービス(このサービスが依存するサービス)を特定します
- すべての下流サービス(このサービスに依存するサービス)を特定します
- API コントラクトと連携ポイントを記録します
- 廃止スケジュールを依存チームに通知します
- 依存サービスの移行経路を計画します
- サービスディスカバリーとレジストリを更新します
7. 監視と可観測性のクリーンアップ
- 監視ダッシュボードを削除します
- アラートルールと通知チャネルを削除します
- ログの集約と保持を整理します
- トレーシングと APM の設定を削除します
- 必要に応じて過去のメトリクスをアーカイブします
- ステータスページとドキュメントを更新します
8. ドキュメントとナレッジ移管
- 技術ドキュメントをアーカイブします
- アーキテクチャ図を更新します
- 運用手順書と SOP を削除またはアーカイブします
- チームの Wiki とナレッジベースを更新します
- 得られた教訓を記録します
- インシデントレポートと事後分析をアーカイブします
9. 財務および管理
- サブスクリプションと定期請求を解約します
- コスト配分タグを削除します
- 予算とキャパシティプランニングを更新します
- 請求書と請求記録をアーカイブします
- 必要に応じてドメイン登録を移管します
10. 最終確認
- すべてのリソースが削除またはアーカイブされていることを確認します
- 想定外の料金が発生していないことを確認します
- 依存するサービスが正常に機能していることを検証します
- 関係者とともに廃止の承認を完了します
- この廃止ドキュメントをアーカイブします
出力形式
次の内容を含む DECOMMISSION-${1:-[SERVICE_NAME]}.md という名前の Markdown ファイルを作成します。
- 明確なセクション見出し
- 各アクション項目のチェックボックス
- 具体的なリソース識別子(汎用的なプレースホルダーではなく)
- 各主要セクションのタイムラインと担当者
- 関連するドキュメントやツールへのリンク
- 緊急ロールバック手順
重要事項
- このドキュメントは、状況を把握しやすい デプロイ時 に作成してください
- 例ではなく、実際のリソース識別子を記載してください
- サービスの進化に合わせて最新の状態に保ってください
- 簡単にアクセスできるよう、サービスのリポジトリに保存してください
- 四半期ごと、または大きな変更の後に見直して更新してください
コメント
Markdown 対応