用途:确保所有面向用户的功能变更都同步反映到功能文档中。核心原则是用户必须能发现并理解全部功能,未文档化的功能对用户等于不存在。开始使用时需声明正在使用 features-documentation 校验功能文档同步。
触发条件:变更影响用户可见功能时触发,例如新增功能、功能修改、功能移除、UI 交互变化、新增配置或设置选项。
主要能力:协议分四步。第一步检测功能变更,用 git diff --name-only HEAD~1 配合 grep 检查 components/、pages/、views/、screens/、features.、feature-flags、config/、settings、preferences 等路径;第二步查找文档文件,依次查找 docs/features.md、docs/FEATURES.md、FEATURES.md、docs/user-guide.md、docs/guide.md,以及 README.md 中的 Features 章节,未找到则暂停并触发 documentation-audit 创建;第三步校验功能覆盖,从代码提取功能名并与文档标题对比,找出未文档化项;第四步处理漂移,输出含未文档化功能列表的暂停报告,随后调用 documentation-audit 技能同步。
文档要求:每个功能需包含清晰名称、描述、使用方法步骤、前置条件、配置选项、示例、限制;文档结构含概述、核心功能、高级功能、实验性功能、已弃用功能及最后更新日期。更新后可用 npx markdownlint docs/features.md、npx markdown-link-check docs/features.md 校验,并检查 How to Use 章节数量。
适用场景与限制:适用于有用户界面的产品项目;纯内部变更、仅后端或基础设施、仅测试文件、仅文档本身或无可视界面的库可跳过。具体执行细节与失败处理以原技能定义为准,资料未提供更多实现或收费信息。