Skip to main content

26. Documentation Governance

Tier: Agency Only | Part: Advanced Topics

Documentation Health Scorecard

## Documentation Health Score — [Product Name]
**Date:** [Date]
**Scored by:** [Name]

### Coverage (out of 30)
- [ ] All endpoints documented (10 pts)
- [ ] All error codes documented (10 pts)
- [ ] Getting started guide exists (10 pts)

### Accuracy (out of 30)
- [ ] All code examples tested (15 pts)
- [ ] No broken links (10 pts)
- [ ] Reviewed in last 90 days (5 pts)

### Quality (out of 20)
- [ ] Style guide followed (10 pts)
- [ ] Consistent terminology (10 pts)

### Usability (out of 20)
- [ ] Clear navigation (10 pts)
- [ ] Search working (10 pts)

**Total: [X] / 100**

Quarterly Documentation Audit

## Documentation Audit — Q[X] [Year]

### New Since Last Audit
- [ ] List new endpoints added
- [ ] List new features added

### Updated Since Last Audit
- [ ] List endpoints that changed

### Still Accurate?
- [ ] Review top 10 most-visited pages
- [ ] Check all code examples still work
- [ ] Verify all links are working

### Action Items
| Issue | Priority | Owner | Due Date |
|---|---|---|---|
| | | | |

Checklist

  • Documentation ownership assigned
  • Review cycle established (quarterly minimum)
  • Health scorecard completed
  • Action items tracked