playbooks

home / skills / gtmagents / gtm-agents / quality-review-checklist

quality-review-checklist skill

/plugins/technical-writing/skills/quality-review-checklist

This skill guides QA reviews of docs and release notes, ensuring accuracy, style, accessibility, localization, and version control.

npx playbooks add skill gtmagents/gtm-agents --skill quality-review-checklist

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
1.3 KB
---
name: quality-review-checklist
description: Checklist covering accuracy, style, accessibility, and localization requirements
  for documentation releases.
---

# Quality Review Checklist Skill

## When to Use
- Pre-publication QA for docs, tutorials, and release notes.
- Auditing inherited content during migrations.
- Training new contributors on required review steps.

## Framework
1. **Accuracy & Coverage** – verify features, parameters, screenshots, and examples match latest build.
2. **Style & Voice** – enforce style guide, terminology, formatting, and tone per audience.
3. **Accessibility** – heading hierarchy, alt-text, captions, contrast, keyboard navigation, screen-reader cues.
4. **Localization & Compliance** – translation scope, legal disclaimers, export controls, privacy statements.
5. **Version Control** – version tags, changelog entries, rollback plan, owner assignments.

## Templates
- QA checklist spreadsheet with pass/fail + notes fields.
- Reviewer sign-off sheet with timestamps and comments.
- Issue log for follow-up fixes grouped by severity.

## Tips
- Pair reviewers (technical + editorial) for faster turnarounds.
- Automate linting scripts (links, markdown, accessibility) and attach results to the checklist.
- Use with `publish-release-documentation` for final approvals.

---

Overview

This skill provides a practical quality-review checklist for documentation releases, covering accuracy, style, accessibility, localization, and version control. It is designed to be used before publication or during audits to ensure consistent, compliant, and user-focused documentation. The checklist includes templates and automation tips to speed reviews and capture sign-off details.

How this skill works

The skill walks reviewers through a structured framework: confirm technical accuracy and coverage, enforce style and voice, validate accessibility requirements, and check localization and compliance items. It pairs manual checks (screenshots, examples, legal text) with automated linting and accessibility reports. Reviewers record pass/fail outcomes, notes, and signer information in standard templates and log follow-up issues by severity.

When to use it

  • Pre-publication QA for docs, tutorials, and release notes
  • Auditing inherited content during migrations or consolidations
  • Training new contributors on mandatory review steps
  • Before tagging a release or updating changelogs
  • When validating translated or region-specific documentation

Best practices

  • Pair technical and editorial reviewers to catch both factual and style issues
  • Attach automated linting and accessibility results to checklist entries
  • Use templates for pass/fail checks, reviewer sign-off, and an issue log
  • Group follow-up fixes by severity and assign owners with deadlines
  • Include version tags and rollback plans as part of every release review

Example use cases

  • Run the checklist as the final step before publishing release notes for a product update
  • Audit a large documentation import during a site migration to ensure consistency
  • Validate localized docs to confirm translations, legal text, and region controls are present
  • Onboard a new documentation contributor by walking them through the checklist
  • Integrate automated markdown and accessibility linting into the review artifacts

FAQ

Can the checklist be automated?

Yes. Automate link checking, markdown linting, and basic accessibility scans, then attach results to the checklist for manual review of items that require human judgment.

What templates are included?

Templates typically include a QA spreadsheet with pass/fail and notes, a reviewer sign-off sheet with timestamps, and an issue log grouped by severity.