1.3 KiB
1.3 KiB
name, description
| name | description |
|---|---|
| quality-review-checklist | 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
- Accuracy & Coverage – verify features, parameters, screenshots, and examples match latest build.
- Style & Voice – enforce style guide, terminology, formatting, and tone per audience.
- Accessibility – heading hierarchy, alt-text, captions, contrast, keyboard navigation, screen-reader cues.
- Localization & Compliance – translation scope, legal disclaimers, export controls, privacy statements.
- 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-documentationfor final approvals.