Service Decommission Documentation Generator

服务下线文档生成器

Generate a comprehensive decommission checklist for ${1:-[SERVICE_NAME]} to be created at deployment time when all context is fresh.

为${1:-[SERVICE_NAME]}生成一份全面的下线检查清单，建议在部署时创建，此时所有相关信息都是最新的。

Your Task

你的任务

Create a detailed decommission documentation file that includes:

创建一份详细的下线文档文件，包含以下内容：

1. Service Overview

1. 服务概述

Document the service name, purpose, and deployment date
List all environments (dev, staging, production)
Note key stakeholders and team contacts
Record repository and deployment locations

记录服务名称、用途和部署日期
列出所有环境（dev、staging、production）
记录关键利益相关者和团队联系人
记录代码仓库和部署位置

2. Infrastructure Resources Checklist

2. 基础设施资源检查清单

Create a checklist covering:

Cloud resources (compute instances, containers, serverless functions)
Storage resources (databases, object storage, file systems, volumes)
Network resources (load balancers, DNS records, CDN configurations)
Security resources (SSL certificates, API keys, service accounts, IAM roles)
Monitoring and alerting (dashboards, alert rules, log aggregations)
CI/CD pipelines and automation jobs
Scheduled tasks and cron jobs

创建一份涵盖以下内容的检查清单：

云资源（计算实例、容器、无服务器函数）
存储资源（数据库、对象存储、文件系统、卷）
网络资源（负载均衡器、DNS记录、CDN配置）
安全资源（SSL证书、API密钥、服务账号、IAM角色）
监控与告警（仪表盘、告警规则、日志聚合）
CI/CD流水线和自动化任务
定时任务和Cron作业

3. Data Management Checklist

3. 数据管理检查清单

Identify all data stores and their locations
Create data backup procedures and retention policies
Document data migration or archival requirements
Plan for data deletion in compliance with policies
Verify backup completion and integrity
Document legal/compliance data retention requirements

识别所有数据存储及其位置
制定数据备份流程和保留策略
记录数据迁移或归档要求
规划符合政策要求的数据删除流程
验证备份完成情况和完整性
记录法律/合规性数据保留要求

4. Access and Security Checklist

4. 访问与安全检查清单

Revoke service accounts and API credentials
Remove IAM roles and permissions
Rotate any shared secrets or keys
Update security groups and firewall rules
Remove OAuth applications and integrations
Audit and remove user access
Update password vaults and secret managers

撤销服务账号和API凭证
移除IAM角色和权限
轮换所有共享密钥或密码
更新安全组和防火墙规则
移除OAuth应用和集成
审计并移除用户访问权限
更新密码库和密钥管理器

5. DNS and Networking Checklist

5. DNS与网络检查清单

Document all DNS records (A, CNAME, TXT, MX, etc.)
Plan DNS record removal or updates
Update load balancer configurations
Remove or update CDN configurations
Document any hardcoded URLs or endpoints
Notify dependent services of endpoint changes

记录所有DNS记录（A、CNAME、TXT、MX等）
规划DNS记录的移除或更新
更新负载均衡器配置
移除或更新CDN配置
记录所有硬编码的URL或端点
通知依赖服务端点变更情况

6. Integration and Dependencies Checklist

6. 集成与依赖检查清单

Identify all upstream services (services this one depends on)
Identify all downstream services (services depending on this one)
Document API contracts and integration points
Notify dependent teams of decommission timeline
Plan migration path for dependent services
Update service discovery and registries

识别所有上游服务（本服务依赖的服务）
识别所有下游服务（依赖本服务的服务）
记录API契约和集成点
通知依赖团队下线时间线
规划依赖服务的迁移路径
更新服务发现和注册中心

7. Monitoring and Observability Cleanup

7. 监控与可观测性清理

Remove monitoring dashboards
Delete alert rules and notification channels
Clean up log aggregation and retention
Remove tracing and APM configurations
Archive historical metrics if needed
Update status pages and documentation

移除监控仪表盘
删除告警规则和通知渠道
清理日志聚合和保留设置
移除追踪和APM配置
如有需要，归档历史指标
更新状态页面和文档

8. Documentation and Knowledge Transfer

8. 文档与知识转移

Archive technical documentation
Update architecture diagrams
Remove or archive runbooks and SOPs
Update team wikis and knowledge bases
Document lessons learned
Archive incident reports and postmortems

归档技术文档
更新架构图
移除或归档运行手册和标准操作流程（SOPs）
更新团队Wiki和知识库
记录经验教训
归档事件报告和事后分析文档

9. Financial and Administrative

9. 财务与行政管理

Cancel subscriptions and recurring charges
Remove cost allocation tags
Update budget and capacity planning
Archive invoices and billing records
Transfer domain registrations if needed

取消订阅和定期收费项目
移除成本分配标签
更新预算和容量规划
归档发票和账单记录
如有需要，转移域名注册

10. Final Verification

10. 最终验证

Verify all resources are deleted or archived
Confirm no unexpected charges appear
Validate dependent services are functioning
Complete decommission sign-off with stakeholders
Archive this decommission documentation

验证所有资源已删除或归档
确认无意外费用产生
验证依赖服务运行正常
与利益相关者完成下线签字确认
归档本下线文档

Output Format

输出格式

Create a markdown file named

DECOMMISSION-${1:-[SERVICE_NAME]}.md

with:

Clear section headers
Checkboxes for each action item
Specific resource identifiers (not generic placeholders)
Timeline and responsible parties for each major section
Links to relevant documentation and tools
Emergency rollback procedures

创建一个名为

DECOMMISSION-${1:-[SERVICE_NAME]}.md

的Markdown文件，包含：

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

Important Notes

重要说明

This documentation should be created at deployment time when context is fresh
Include actual resource identifiers, not examples
Keep it updated as the service evolves
Store it in the service repository for easy access
Review and update quarterly or after major changes

本文档应在部署时创建，此时相关信息是最新的
包含实际的资源标识符，而非示例
随着服务演进持续更新
存储在服务代码仓库中以便访问
每季度或在重大变更后审查和更新

docs-decommission

Original

Translation