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 文件，其中包含：

• 清晰的章节标题
• 每项操作的复选框
• 具体的资源标识符（而非通用占位符）
• 各主要章节的时间线和负责人
• 相关文档和工具的链接
• 紧急回滚流程

重要说明

• 应在部署时创建此文档，趁相关背景信息仍清晰时完成
• 填入实际资源标识符，而非示例
• 随服务演进持续更新
• 将其存放在服务代码仓库中，以便轻松访问
• 每季度或重大变更后进行审查和更新