Skip to main content

/qa-doc-review

Source: ~/.claude/skills/qa-doc-review/SKILL.md

name: qa-doc-review version: "2.0" level: 3 trigger: "QA review, doc review, documentation review, qa-doc, review documentation, check docs" author: john updated: 2026-03-16

QA-Doc Review — Level 3 Supervised Skill

Sistematski pregled dokumentacije i QA artefakata. Provjerava completeness, accuracy, i linkove.

WHEN TO USE

  • IF "doc review", "review docs", "check documentation", "QA doc" → activate
  • IF completing a task with docs deliverable → run as post-step validation

WORKFLOW

Step 1: Classify Document Type

IF task documentation → validate against GOTCHA acceptance criteria
IF API documentation → check endpoint coverage, examples, error codes
IF runbook/ops doc → check command accuracy (run commands to verify)
IF architecture doc → check against actual system (query HiveMind)
IF changelog → check version format, completeness

Step 2: Accuracy Check

# For runbooks: verify commands actually work
# Run key commands and compare output to what doc claims
IF command in doc:
  run command → compare output → flag discrepancies

Step 3: Quality Checklist

[ ] Title and metadata present (date, author, version)
[ ] All claimed commands/URLs are verified working
[ ] No localhost:XXXX references in production docs
[ ] No "TODO" or "FIXME" placeholders left
[ ] Links resolve (internal wiki + external)
[ ] Screenshots/diagrams are current (not stale)
[ ] GOTCHA acceptance criteria met (if task doc)
[ ] HiveMind post confirmed (if knowledge doc)

Step 4: BookStack Sync Check

# IF doc should be in BookStack:
cat ~/system/config/bookstack-sync-map.json | grep "[filename]"
# Verify sync status

OUTPUT FORMAT (report to John, not user)

QA-DOC REVIEW REPORT

Status: APPROVED | NEEDS_WORK | BLOCKED
Document: [title/path]
Type: [task-doc | runbook | api-doc | architecture | changelog]

❌ BLOCKERS:
  - [issue]

⚠️  WARNINGS:
  - [issue]

✅ CONFIRMED WORKING:
  - [verified items]

BookStack: SYNCED | NOT_SYNCED | N/A
HiveMind: POSTED | NOT_POSTED | N/A

Verdict: [one sentence]
Back to top