SuperAPI AI 工具集

business-feature-docs

写作与研究

查看项目

更新于 10-15 21:35

技能介绍

用途:为 EasyPlatform 项目生成企业级业务功能文档,遵循 GOLD STANDARD 模板,适用于模块文档、企业功能说明与详细规格编写。

主要能力:按 26 节固定结构生成模块文档,含按角色快速导航表;业务需求使用 FR-{MOD}-XX 编号,测试用例使用 TC-{MOD}-XXX 并采用 GIVEN/WHEN/THEN 格式;生成约 300 行、10 节的 AI 伴读文件(上下文、文件位置、领域模型、API 契约、业务规则、模式、集成、安全、测试场景、快速参考);更新主索引 docs/BUSINESS-FEATURES.md。

使用方式:先识别目标模块并阅读现有文档(docs/BUSINESS-FEATURES.md、模块 INDEX.md 与 README.md),再从实体、命令、查询、控制器与前端目录收集代码证据,然后生成文档。必须阅读的参考文件包括 .claude/skills/shared/business-docs-26-sections.md、bdd-gherkin-templates.md、anti-hallucination-protocol.md,以及 docs/features/README.ExampleFeature1.md 与 docs/templates 下的两个模板。

限制:强制代码证据规则,每条测试用例须标注 {相对文件路径}:{行号} 或行号区间,禁止无行号或模糊表述;文档前须实际阅读源码,不得臆测行为;AI 伴读文件不超过 300 行。具体安装命令与收费信息暂未提供。