mcpField
Q
quality-advisor

quality-advisor

github.com/vladm3105文档处理1759 次安装1 天前更新
代码仓库

关于 quality-advisor

quality-advisor 是用于 SDD 文档编写和提交前审查的质量检查技能，可按文档层级评估完整度、标签与命名，并给出分级问题和改进建议。

主要功能

  1. 01评估必需章节的完成度
  2. 02检测文档反模式并标注严重性
  3. 03核验累积标签及缺失项
  4. 04检查文档与元素 ID 命名
  5. 05生成评分、问题统计和后续建议

适用场景

  1. 01撰写 SDD 文档时获取即时反馈
  2. 02提交前检查单份文档
  3. 03核对模板、标签和命名规范

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill quality-advisor

安装后在 Claude Code 中输入/quality-advisor确认已加载。

详细介绍

quality-advisor

用途

在编写 SDD 制品时，及时主动提供质量指导，以便在创建过程中发现问题，而不是等到创建后再验证。它会对章节完成度评分、检测文档反模式、检查累积标签并验证命名，然后给出可执行的建议。

何时使用

在以下情况下使用 quality-advisor：

  • 编写新制品并希望获得实时反馈。
  • 提交前审查制品。
  • 检查单个文档是否符合模板要求、标签或命名规范。

不要将其用于完整的双向可追溯性或整个项目的验证（请使用 ../doc-validator/SKILL.md），也不要用于非 SDD 文档。

行为

给定制品内容、类型和可选的检查级别（quick / standard / strict），该技能会：

  1. 加载制品所在层的模板要求，来源为 ${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml — 必需章节、最低标签数量 及特殊规则（例如 PRD KPI 必须量化、EARS WHEN-THE-SHALL 语法、SPEC YAML 格式）。代码是 IPLAN 的下游执行目标，而不是文档制品。
  2. 评估章节完成度 — 检测必需章节，标记缺失或不完整的章节，并提供完成度评分及具体问题。
  3. 检测反模式 — 缺少 Document Control、占位文本、验收标准含糊、缺少可追溯性标签、链接失效、ID 格式违规、空章节、孤立制品、数量／交叉引用不匹配、未定义的缩略语、混用 ID 表示法、对不存在文档的前向引用 — 每项均提供严重级别和修复建议。
  4. 验证累积标签 — 确认制品仅包含其所在层要求的上游标签系列（BRD 0 → … → IPLAN 7），没有遗漏，也没有下游标签。
  5. 检查命名 — 文档 ID TYPE-NN、元素 ID TYPE.NN.SS.xxxx、阈值标签和文件名 slug；遵循 ../doc-naming/SKILL.md 和 ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md；标记旧式模式。
  6. 生成质量报告 — 总体状态和评分、错误／警告／信息数量、各区域结果，以及按优先级排序的建议和后续步骤 （通常是：修复错误，然后运行 ../doc-validator/SKILL.md）。

该框架不包含运行时代码 — 此技能本身就是检查器，会根据规范应用上述声明式检查。

相关资源

  • 层注册表和标签规则：${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml
  • ID 和标签标准：${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md
  • 各层 README：${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/README.md · ${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/README.md
  • 命名：../doc-naming/SKILL.md
  • 创建后验证：../doc-validator/SKILL.md · 各层的 -audit 技能 （例如 ../doc-prd-audit/SKILL.md）
  • 路由和后续步骤：../doc-flow/SKILL.md

评论

支持 Markdown