SuperAPI AI 工具集

docs-check

编程与开发

查看项目

更新于 10-16 00:02

技能介绍

用途:docs-check(ada::docs:check)用于分析 git diff,找出需要同步更新文档的代码变更,并给出应检查或修改的文档文件建议。

主要能力:按类别归类变更并映射到文档,例如数据库/模式变更对应 .docs/db/ 文件,API 变更对应 .docs/api/ 与 .docs/workflow/ 文件,组件/UI 变更对应组件文档,配置变更对应安装/设置文档,认证变更对应认证文档,测试变更对应测试文档等。输出包含按类别组织的变更代码文件、建议审阅的文档文件以及更新指引。

使用方式:运行 bash skills/docs-check/scripts/check-docs.sh,加 --verbose 可查看更详细信息。随后审阅分类结果与建议文档,阅读 references/documentation-guide.md 校验现有文档是否符合标准,再按 skills/docs-write/SKILL.md 工作流更新文档,最后重新运行检查直至所有建议处理完毕。

适用场景:可在 ada::code-review 之后检查已审阅变更是否需要文档;在 ada::code-quality 收尾前确保文档随代码更新;在准备 PR 时确认文档完整。

限制与要求:必须始终加载 references/documentation-guide.md,用于校验文档结构、风格与一致性并指导更新,不应自行假设文档格式。资料未提供安装方式、平台支持、收费与效果等信息。