| name | real-team-handover-docs-generator |
| description | 当用户输入 `/handvoer`、`/handover`，或请求“写一个skill，项目要给另一个团队的开发部门接手”“现在生成一个完整的开发文档和运维文档”“便于接手开发”“生成开发文档和运维文档”“handover”“移交文档”“runbook”等中英文等价表述时立即激活。输出两份专业 Markdown 文档：`DEV_HANDOVER.md` 和 `OPS_RUNBOOK.md`，专为真人开发与运维团队交接设计。 |
Real Team Handover Docs Generator
Skill用途与成功标准
生成完整、可直接用于生产移交的文档。目标效果：新团队阅读后 1 周内可独立部署、开发迭代、日常运维，沟通成本显著下降。
使用如下成功标准校验输出质量：
- 包含 TOC、Mermaid 图、代码块、可执行步骤、验收 checklist
- 结构清晰、专业、实用、零废话
- 命令可复制执行，步骤可落地验证
工作流程（严格执行）
- 收集项目上下文：从用户或现有项目中获取技术栈、架构、repo结构、部署方式、关键功能、已知问题。
- 输出完整大纲与架构章节：先给出文档骨架，再产出架构与数据流关键内容。
- 填充代码与配置：补齐命令、配置示例、接口示例、运维步骤。
- 添加图表与格式优化：加入 Mermaid 图、表格、结构化 checklist。
- 交叉审查迭代一次：检查可执行性、完整性、一致性。
- 输出最终文档：产出
DEV_HANDOVER.md 与 OPS_RUNBOOK.md，并附移交验收 checklist。
开发文档（DEV_HANDOVER.md）标准章节
采用 Diátaxis 与 GitHub 文档实践，至少包含：
- 项目概览与业务目标
- 系统架构与数据流（必含 Mermaid 图）
- 技术栈与依赖清单
- 代码库结构与关键文件说明
- 数据库 Schema 与 ER 图
- API/接口规范（endpoints、鉴权、请求示例）
- 测试策略与 CI/CD 流水线
- 本地/开发环境搭建步骤（可复制命令）
- 编码规范、最佳实践与技术债
- 已知问题与规避方案
- 扩展与二次开发指南
- 交接验收 checklist（新团队必执行项）
运维文档（OPS_RUNBOOK.md）标准章节
采用 Runbook 模板，至少包含：
- 基础设施与部署拓扑（Mermaid）
- 配置管理、环境变量、Secrets 处理
- 监控、日志、告警设置（工具与阈值）
- 日常运维 SOP 与 checklist
- 故障排查指南（常见问题 + 步骤 + 回滚命令）
- 备份恢复与灾备方案
- 安全合规与访问权限矩阵
- 性能优化与扩容指南
- 应急响应与升级联系人
- 工具清单与访问方式
- 移交验证 checklist（新团队必执行项）
输出格式要求
- 使用纯 Markdown，具备高可读性：标题、表格、代码块、Mermaid、TODO 标记
- 文档开头必须写明版本与生成日期
- 文档结尾必须包含“PDF 导出建议”与“验收签字模板”
- 所有代码与命令可直接复制执行
- 语言优先中文，专业术语保留英文并附中文解释
- 保持真人团队交接文档风格，不写 AI 自述
通用指令
- 生成前先确认上下文；上下文不足时优先从仓库结构、配置文件、脚本与部署文件补齐
- 输出后自动追加声明：
文档已优化为真人团队交接使用，可直接打印/分享。
- 非必要不省略关键章节；若信息缺失，明确标注
TODO(待补充) 并给出采集建议
- 默认在当前工作区产出
DEV_HANDOVER.md 与 OPS_RUNBOOK.md，除非用户指定其他路径
