SuperAPI AI 工具集

docs-quality-check

写作与研究

查看项目

更新于 10-15 23:49

技能介绍

用途:对代码库文档进行质量分析,覆盖 PRD(产品需求文档)、ADR(架构决策记录)、PRP(产品需求提示)、CLAUDE.md 与 .claude/rules/ 规则文件,评估其结构、完整性、时效性与规范符合度。

主要能力:按九个阶段执行。先建立待办清单,再依次分析 CLAUDE.md 结构与内容、检查 .claude/rules/ 目录与规则文件、校验 ADR/PRD/PRP 的目录、命名与必需章节,并通过 git 历史做时效性分析,检查是否存在文档过时或代码变更未同步文档的情况。最终生成文档清单表、分类质量评分(结构、完整性、时效性、规范符合、内容质量,1-10 分)、问题分级(严重、警告、建议)和可执行改进清单。

使用方式:该技能接受一个参数 $1 作为待分析路径,未指定时默认当前目录。资料中给出用于探测环境的命令,例如:find .claude -maxdepth 1 -name 'blueprints' -type d、find . -maxdepth 1 -name 'CLAUDE.md' -type f、find .claude/rules -maxdepth 1 -name '*.md',以及 git log --since="6 months ago" --oneline -- docs/ .claude/ CLAUDE.md。资料提及相关命令 /docs:quality-check、/blueprint:init、/blueprint:adr、/blueprint:prd,并建议每月运行一次质量检查。

适用场景:维护使用 CLAUDE.md 与 .claude 规则的 AI 辅助开发项目,需要定期审查 ADR/PRD/PRP 文档质量与时效性的团队。

限制:资料未说明具体平台支持、收费方式、价格或实际使用效果。若目录不存在则记为缺失,非 git 仓库时跳过基于 git 的时效检查;需要用户自行提供路径与项目文档结构。