SuperAPI AI 工具集

nemoclaw-contributor-update-docs

写作与研究

查看项目

更新于 10-16 02:34

技能介绍

用途:在合并后补齐文档,或按用户请求做文档漂移审计。以已签入源码、测试和已接受的产品范围为行为权威,不依据历史文档或提交信息推断命令、默认值、路径或支持声明。

主要能力:确定变更范围(合并后补齐时,检查从最近可达 semver 标签到已推送 main 提交;直接文档任务使用用户给定的提交范围或当前检出上下文);加载当前权威(遵循 Discover the Current Implementation,阅读现行文档指南、共享的 Documentation Writing and Review 契约、当前文档导航,以及仓库文档 skip 文件及其排除项与禁用词);逐项判断变更是否影响用户可见行为,在源码与测试中验证,确认产品范围,定位拥有该行为的页面,并在编辑共享内容前检查所有适用的指南变体;只更新拥有该行为的最窄页面,仅在现行指南要求时新建或重构页面(信息架构工作改用 nemoclaw-maintainer-refactor-docs)。

使用方式:合并后补齐时只改 docs/、fern/docs.yml、fern/assets/,由工作流独立审查补丁,必需 PR 检查运行 npm run docs,作者步骤不做 GitHub 写入;直接文档任务则运行从仓库指南与包脚本发现的当前文档检查,检查受影响的生成变体与链接。用户要求发布直接文档 PR 时使用 nemoclaw-contributor-create-pr。

适用场景:合并后文档补齐、文档漂移审计、直接文档更新任务。

限制:发布条目补全属于 nemoclaw-maintainer-evening,不属本工作流;忽略仅测试与内部重构,除非暴露文档缺陷;不重复书写规则、页面归属、路由约定、代理变体、变更日志格式或验证命令,这些从现行指南、源码树、包脚本与工作流推导;不得在撰写期间推进范围边界;对已有托管草稿,在与 main 合并后扩展其暂存变更,除非当前源码与测试证明需要修订或删除,否则保留既有文档变更。