SuperAPI AI 工具集

doc-validator

写作与研究

查看项目

更新于 10-16 03:44

技能介绍

doc-validator 是一个文档验证技能,用于检查文档文件的完整性、准确性和与代码库的一致性。

主要检查维度:

完整性:是否包含安装说明、使用示例、API 参考(如适用)、故障排查章节、贡献指南(如开源项目)。

准确性:代码示例是否可运行、命令是否与实际 CLI 一致、文件路径是否存在、版本号是否与 package.json/pyproject.toml 匹配、链接是否失效。

一致性:术语是否统一、示例代码风格是否与项目一致、格式是否统一、目录是否与标题匹配。

质量:有无拼写和语法错误、语言是否清晰简洁、Markdown 格式是否正确、代码块是否带语言标记。

使用方式:该技能会先查找文档文件,例如运行 find . -name ".md" -o -name ".rst",然后读取分析文档结构,验证代码示例,校验链接与引用,并与代码交叉比对:对比 CLI 命令与实际实现、核实文件路径是否存在、检查版本号。最后按类别列出问题、给出改进建议和修复示例。

适用触发场景示例:检查 README 是否完整、验证 API 文档、文档提到 /old-command 但代码中找不到。不适合的场景:撰写新文档(属于创建而非验证)、修复第 42 行错别字(过于具体)。

详细验证规则参见 references/validation-rules.md。