feature-doc-splitter-cnlisted
Install: claude install-skill YangsonHung/awesome-agent-skills
# 功能文档拆分器
## Overview
使用这个技能,将早期功能需求初稿整理成一组三份可落地文档:总览文档、前端实现文档和后端实现文档。
输出必须结合真实代码结构,明确拆分前端和后端职责,定义共享契约,补充必要 Mermaid 图,并把不确定点显式写入假设或待确认事项。涉及新增 UI 表面时,还要判断是否需要预留可选 Pencil 设计稿占位。
## 何时使用
当用户提出以下需求时使用本技能:
- 将初版功能需求文档拆分为总览、前端和后端实现文档。
- 把粗略产品说明整理成可直接开发的技术文档。
- 写功能实现文档前,需要先结合现有代码梳理模块和约定。
- 需要补充 Mermaid 业务流程图、交互流程图、时序图或接口契约索引。
- 需要先询问用户是否为新增前端 UI 表面预留可选 Pencil 设计稿占位。
## 不要使用
以下场景不要使用本技能:
- 直接实现功能代码。
- 只写一份不拆分的 PRD 或宣传说明。
- 在 Pencil 中绘制具体 UI 视觉稿。
- 只做后端 API 设计,且不需要拆成三份功能文档。
- 只做前端组件开发,且不需要总览和后端实现文档。
## 使用说明
按照以下流程执行,并始终按责任归属拆分三份输出文档。
## 必须输出
创建或更新三份文档:
- 总览文档:目标、背景、范围、非目标、业务对象、端到端流程、跨端契约、必需的 Mermaid 图、上线规划、风险和验收标准。
- 前端实现文档:仅描述前端路由、页面、区块、组件、状态、Hook、接口接入点、交互状态、Mermaid 流程图、测试,以及新增 UI 的可选 Pencil 设计稿占位。
- 后端实现文档:仅描述后端数据模型、迁移、接口路由、Schema、服务、校验规则、统计公式、任务、通知或事件创建、Mermaid 流程图、测试和验收标准。
总览文档必须用项目相对路径引用前端和后端实现文档,并且必须包含 Mermaid 代码块。
## 工作流程
1. 先读取仓库规则。
- 编辑前读取相关 `AGENTS.md`。
- 遵循本地文档风格、落位目录、命名和包管理约定。
- 保留与任务无关的用户改动。
2. 完整阅读初版需求文档。
- 识别用户目标、参与角色、业务名词、排行榜或统计规则、可见 UI、后端数据诉求、通知诉求和隐含权限。
- 不清楚的内容写入“假设”或“待确认事项”,不要在文档里静默编造。
3. 写文��前先梳理代码。
- 使用 `rg` 和定向文件阅读查找现有页面、路由、组件、Hook、生成 API 客户端、模型、Schema、服务、测试、通知代码、统计或排行逻辑。
- 优先复用现有模块和项目约定,不为单次需求创造多余抽象。
- 如果已有组件或模块可以复用,在文档中写清复用路径,不创建设计稿占位。
4. 定义文档集合。
- 三份文档使用一致命名。
- 链接统一使用项目相对路径。
- 前端和后端文档都必须能独立指导对应角色实现,不能依赖阅读对方内部细节。
- 共享契约放在总览文档;各实现文档只重复本端需要消费的那部分。
5. 编写总览文档。
- 包含总目标、业务背景、范围、非目标、术语、角色、数据归属、接口契约索引、分阶段计划、验收标准、风险和依赖。
- 总览文档始终至少包含一张 Mermaid 端到端业务流程图。
- 当涉及多角色或多系统协作时,补充 Mermaid 时序图或交互流程图。
6. 编写前端实现文档。