SuperAPI AI 工具集

feature-doc-splitter

写作与研究

查看项目

更新于 10-16 05:03

技能介绍

用途:把早期功能笔记转成工程师可独立落地的小型文档集,输出概览、前端实现、后端实现三份文档;也可用于在写实现文档前检查现有代码库,或补充 Mermaid 业务流程、交互流程、时序图与 API 契约索引。

主要能力:概览文档包含目标、背景、范围、非目标、术语、参与方、数据归属、API 契约索引、上线阶段、验收标准、风险与依赖,必须含至少一张 Mermaid 端到端业务流程;前端文档含路由、页面与组件清单、状态模型、数据加载、空加载错误状态、权限、i18n、测试及 Mermaid 用户交互与业务逻辑流程;后端文档含模型、迁移、API 端点、请求响应 schema、operationId、服务类、校验、幂等、统计公式、事件、任务与测试;多系统参与时补时序图。若项目使用生成式 API 客户端,需说明 OpenAPI 生成影响与重新生成命令。

用法:先读仓库说明与相关 AGENTS.md,保持既有文档风格、命名与包约定,保留无关的用户改动;完整阅读功能笔记,将歧义记为假设或待确认问题;用 rg 和定向读文件查找既有页面、路由、组件、hooks、模型、schema、服务、测试、通知与统计逻辑,优先复用既有模块。三份文档命名一致、使用项目相对路径链接,前端与后端各自可独立实施,共享契约事实放在概览中。关于 Pencil 设计占位:新建前端 UI 面时,若用户未明确表态,先问是否保留占位;仅在用户同意后为真正新增的页面、区块、面板或组件创建 .pen 文件,复用组件标注“reuse existing component, no design placeholder”,不为文本改动、既有列表行、标签页或入口按钮创建 .pen。占位文件可放在如 docs/features/<feature>/pencil/<surface>.pen,空占位内容为 {"version":"2.13","children":[]}。最后校验链接、标题一致性、Mermaid 语法与拆分边界,可用时运行仓库文档或技能校验器,否则至少运行 git diff --check。

适用场景:需三文档拆分的前后端功能、粗略产品笔记转实现文档、写文档前需先查看代码库。

限制:不用于实现功能代码本身、不写单份未拆分 PRD 或营销简报、不用 Pencil 设计 UI 视觉、不做无需三文档拆分的纯后端 API 设计或纯前端组件工作。资料未提供具体平台、收费与价格信息。