mcpField
Q
quality-advisor

quality-advisor

github.com/vladm3105Documents1759 installsUpdated 1d ago
Repository

About quality-advisor

quality-advisor is a skill for checking SDD artifacts during drafting or before submission. It evaluates completeness, tagging, and naming by document layer, then reports issues by severity with actionable recommendations.

Key features

  1. 01Score required-section completion
  2. 02Detect documentation anti-patterns
  3. 03Validate cumulative tags and gaps
  4. 04Check document and element IDs
  5. 05Report scores, issues, and next steps

Use cases

  1. 01Get feedback while drafting an SDD artifact
  2. 02Review a document before submission
  3. 03Check template, tag, and naming compliance

Install

Copy the command and run it in a terminal.

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

After installing, type/quality-advisorin Claude Code to confirm it loaded.

Details

From the project README

quality-advisor

Purpose

Give proactive, in-the-moment quality guidance while an SDD artifact is being written, so issues are caught during creation instead of at post-creation validation. It scores section completion, detects documentation anti-patterns, checks cumulative tagging, and validates naming — then returns actionable recommendations.

When to Use

Use quality-advisor when:

  • Authoring a new artifact and wanting live feedback.
  • Reviewing an artifact before submission.
  • Checking template-requirement, tag, or naming compliance for one document.

Do not use it for full bidirectional traceability or whole-project validation (use ../doc-validator/SKILL.md), or non-SDD documentation.

Behavior

Given the artifact content, its type, and an optional check level (quick / standard / strict), the skill:

  1. Loads template requirements for the artifact's layer from ${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml — required sections, minimum tag count, and special rules (e.g. PRD KPIs must be quantitative, EARS WHEN-THE-SHALL syntax, SPEC YAML form). Code is the downstream execution target of IPLAN, not a documentation artifact.
  2. Scores section completion — detects required sections, flags missing/partial ones, and reports a completion score with specific issues.
  3. Detects anti-patterns — missing Document Control, placeholder text, vague acceptance criteria, missing traceability tags, broken links, ID-format violations, empty sections, orphan artifacts, count/cross-reference mismatches, undefined acronyms, mixed ID notation, forward references to non-existent documents — each with severity and a fix suggestion.
  4. Validates cumulative tagging — confirms the artifact carries exactly the upstream tag families its layer requires (BRD 0 → … → IPLAN 7), with no gaps and no downstream tags.
  5. Checks naming — document IDs TYPE-NN, element IDs TYPE.NN.SS.xxxx, threshold tags, and filename slugs, deferring to ../doc-naming/SKILL.md and ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md; flags legacy patterns.
  6. Generates a quality report — overall status and score, error/warning/info counts, per-area results, and prioritized recommendations plus next steps (typically: fix errors, then run ../doc-validator/SKILL.md).

The framework ships no runtime code — this skill IS the checker, applying the declarative checks above against the spec.

Related Resources

  • Layer registry & tag rules: ${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml
  • ID & tag standards: ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md
  • Layer READMEs: ${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/README.md · ${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/README.md
  • Naming: ../doc-naming/SKILL.md
  • Post-creation validation: ../doc-validator/SKILL.md · layer -audit skills (e.g. ../doc-prd-audit/SKILL.md)
  • Routing & next steps: ../doc-flow/SKILL.md

Comments

Markdown supported