SuperAPI AI 工具集

documentation quality analysis

测试与质量

查看项目

更新于 10-15 23:49

技能介绍

用途:面向采用 Blueprint Development 方法与 Claude Code 约定的代码库,系统分析技术文档的质量、结构与维护状态,确保符合规范且内容新鲜。

主要能力:覆盖 CLAUDE.md、.claude/rules/、ADR、PRD、PRP 五类文档;校验必需章节、YAML frontmatter(created/modified/reviewed)、命名规范(如 ADR 采用 NNNN-title.md)、时效性与交叉引用;按结构、完整性、新鲜度、标准符合度、内容质量五个维度打分(0-10,取平均),并输出关键问题(必修)、警告(应修)与建议(可选)及带具体文件的修复建议。

使用方式:先盘点文档(find 多模式匹配),再逐类读取校验 frontmatter 与章节(grep),检查新鲜度(find -mtime +180、git log --since="6 months ago"),最后计分并生成报告。质检时的必要命令保持原样,例如:grep -A 5 "^---$" CLAUDE.md | grep -E "(created|modified|reviewed):" 与 find docs -name "*.md" -mtime +180。

适用场景:维护多种技术文档的代码库、需要为 AI 助手准备上下文、新人上手知识沉淀、文档债审计与月度/季度定期审查。

限制:资料未说明具体安装步骤、支持平台、收费或价格;评分方法为公开资料给出的主观维度,实际结果依赖仓库内容与 git 历史;文中出现的斜杠命令(如 /docs:quality-check)资料未给出实现细节。