Docs Quality Reviewer — Debug Workflow¶
Description: Fix issues and errors in artifacts
When to Use¶
Use the debug workflow when you need to fix issues and errors in artifacts.
Input Requirements¶
- Documentation drafts and published content
- Style guides and editorial standards (Google developer docs, Microsoft Style Guide)
- Vale and markdownlint rule configurations
- User feedback and support ticket analysis (documentation-related)
Process¶
- Initialize — Set up the debug context for Docs Quality Reviewer
- Execute — Perform the debug operation following Docs Quality Reviewer's style
- Validate — Check output against quality gates
- Handoff — Deliver results to downstream personas
Output¶
- Documentation quality scorecards with per-dimension ratings
- Automated lint reports from Vale and markdownlint pipelines
- Readability analysis with score-per-audience assessments
- Remediation checklists with prioritized actionable findings
Quality Gates¶
- All documentation must pass automated lint checks before manual review
- Readability scores must meet defined thresholds per audience type
- Quality reviews must evaluate all five dimensions (accuracy, completeness, clarity, consistency, usability)
- Review findings must include specific, actionable remediation guidance