40 / 51 · 24 Technical Writing for QA · Documentation as Code← prev⊞ allnext →☰ Read as one page
5.7Documentation Review Process
Who Reviews
| Documentation Type | Primary Reviewer | Secondary Reviewer |
|---|---|---|
| Test strategy | QA Lead | Engineering Manager |
| Test cases / plans | QA peer | Developer (for technical accuracy) |
| Runbooks | QA peer | DevOps (for operational accuracy) |
| API test documentation | QA author | API developer |
| Onboarding guides | Recent hire (validates accuracy) | QA Lead |
When to Review
- On change: Every documentation change goes through a PR review, just like code
- On schedule: Quarterly review of all active documentation for accuracy and relevance
- On trigger: When a related incident occurs, review relevant runbooks and documentation
How to Review Documentation
| Check | Question |
|---|---|
| Accuracy | Is the information correct and current? |
| Completeness | Is anything missing that a reader would need? |
| Clarity | Would someone unfamiliar with the context understand this? |
| Actionability | Can the reader follow these instructions successfully? |
| Consistency | Does it follow the team's style guide and templates? |
| Freshness | Is this still relevant? Are there references to deprecated tools or processes? |