SuperAPI AI 工具集

repo-docs

智能体与模型

查看项目

更新于 10-16 07:24

技能介绍

用途:repo-docs 用于撰写、修订或审计面向用户的仓库文档,包括 README、仓库文档、RFC、PR 描述、提交信息,以及公开发布前的文档准备。其核心假设是读者是陌生人,同时其编码代理也会阅读同一页面并照做,因此每页都应面向这对读者,而非项目所有者。

主要能力:提供两层指导。内容规则适用于所有仓库的所有面向用户文档;格式默认值仅在仓库、生态或文档站没有自身约定时适用,有约定则遵循约定。多数规则是判断,并附有决定该判断的测试。RFC 使用文档模式指导其章节;PR 描述和提交信息使用句子与验证规则,并遵循仓库自身格式;产品 UI 文案使用产品文案指南。

使用方式:按步骤执行。1. 收集事实:阅读待改文档、同类文档、每条声明背后的代码与配置,以及事实在其他位置的回声(网站文案、商店文本、应用内帮助、已安装文档、仓库内其他文档);用 gh repo view --json visibility 检查仓库可见性,并查找既有约定。2. 放置材料:按映射表把每份材料放入拥有它的文档,每个事实只有一个规范归属,其他地方链接过去;起草前阅读 references/technical-writing.md 选择文档模式(教程、操作指南、参考或解释)。3. 起草或修订:应用内容规则与句子规则,再应用仓库约定,最后应用格式默认值;README 需阅读 references/readme.md。4. 验证每条声明:把每条事实句追溯到代码、配置或运行过的命令,无法追溯的修正或删除,并更新所有回声。5. 清扫:对每个改动章节运行 references/audit-checklist.md。6. 提交前预览:在聊天中展示改动文字并等待批准,除非所有者已批准措辞或要求直接提交;发布到公开仓库需要单独明确批准。

适用场景:README、docs/ 指南、参考文档、AGENTS.md、CHANGELOG.md、SECURITY.md、CONTRIBUTING.md、vendored 依赖说明、所有者私有笔记等。

限制:资料未提供具体安装命令、收费、价格、平台或效果信息;文档中的命令与示例需实际运行验证,公开仓库文档不得包含个人域名、账户或部署 ID、私人引用或真实个人数据,应使用占位符与虚构示例。