SuperAPI AI 工具集

features-documentation

写作与研究

查看项目

更新于 10-16 05:42

技能介绍

用途:当变更涉及用户可见功能(新功能、功能修改、功能移除、UI 变化、配置项变化)时,该技能确保功能文档同步更新。核心理念是:用户必须能发现并理解所有功能,未记录的功能对用户而言等于不存在。

主要能力:检测当前变更是否影响用户功能;在常见位置查找功能文档(docs/features.md、docs/FEATURES.md、根目录 FEATURES.md、docs/user-guide.md、docs/guide.md、README.md 的 Features 章节);比对代码中的功能与文档中的功能,找出未记录项;一旦发现文档漂移,暂停当前工作,提示调用 documentation-audit 技能完成同步。

使用方式:技能开始时声明“I'm using features-documentation to verify feature documentation sync.”;以 git diff 检查 components/pages/views/screens、features/feature-flags/config、settings/preferences/config 等路径判断功能是否变化;用查找函数定位文档;通过比对代码 feature 名称与文档标题发现未记录功能。发现漂移时输出状态 PAUSED 与未记录功能清单,并提示运行 documentation-audit,同步后再恢复工作。文档应包含名称、描述、使用方法、前置条件、配置、示例与限制等章节。

适用场景:面向有用户界面或面向用户功能的产品代码库,在实现涉及用户可见变化的改动时触发。纯内部改动、仅后端/基础设施、仅测试文件、仅文档自身或没有 UI 的库可跳过。

限制:原资料未提供具体安装命令、收费信息与平台支持范围,暂未提供。