SuperAPI AI 工具集

nightly-docs-sweep

写作与研究

查看项目

更新于 10-23 16:18

技能介绍

用途:nightly-docs-sweep 是一个文档巡检技能,用于在实现发生变化后,检查仓库文档是否仍然与当前代码、配置和实际行为一致,并产出可审查的文档变更集或拉取请求。

主要能力:它要求对代码库做一次完整审阅,包括 README、安装指南、API 参考、示例、架构说明、代码注释和运行手册等文档;找出已过时或缺失的内容并更新;核对命令、链接、示例、配置名称、API 形态和安装步骤是否与当前仓库一致;运行项目已有的相关检查,例如文档测试、链接检查、类型检查、单元测试或 lint。

使用方式:在执行文档检查时,先回顾自上次文档检查以来的实现变更,再将文档与当前代码、配置、命令和行为逐一对比,只更新不准确或缺失的材料,不为了产生改动而重写正确内容。随后运行可用检查,并汇总文档漂移、改动文件和验证结果。如果用户要求且环境支持,则以清晰标题和正文提交 PR。结束时需报告已检查的文档范围、发现过时或缺失的文档、更新的文件、运行的验证命令及结果、剩余缺口或阻塞项,以及 PR 链接(如已提交)。

适用场景:适合在实现变更可能已让文档落后时使用,例如 README、安装指南、API 参考、示例、架构说明、注释或运行手册需要同步;也可用于定期的夜间或例行文档巡检。

限制:文档范围必须紧扣真实实现行为,不编造代码、配置、测试或项目文档无法支撑的功能;应尽量保留准确文档和用户撰写的措辞。如果仓库过大无法一次完整检查,应优先处理变更频繁或访问量高的文档,并明确说明剩余范围。关于是否需要提交 PR,取决于用户是否要求以及环境是否支持,资料未提供其他具体平台或工具集成细节。