smom-dbis-138/docs/governance/DOCUMENTATION_METRICS.md

# Documentation Metrics Guide

**Last Updated**: 2025-01-27  
**Status**: Active

This guide explains how to track and measure documentation effectiveness.

## Overview

Documentation metrics help measure:
- Documentation coverage
- Link health
- Update frequency
- User engagement
- Documentation quality

## Metrics to Track

### Coverage Metrics

- **Documentation Coverage**: % of features/APIs documented
- **Guide Completeness**: % of guides with all sections
- **Example Coverage**: % of guides with examples

### Quality Metrics

- **Link Health**: % of working links
- **Update Frequency**: Average days since last update
- **Metadata Completeness**: % of docs with metadata headers

### Usage Metrics

- **Page Views**: Documentation page views (if using site generator)
- **Search Queries**: Common search terms
- **User Feedback**: Issues/questions about documentation

## Tracking Methods

### Automated Tracking

```bash
# Count documentation files
find docs -name "*.md" | wc -l

# Check link health
markdown-link-check docs/**/*.md | grep -c "broken"

# Check metadata completeness
grep -r "Last Updated" docs/ | wc -l
```

### Manual Tracking

- Review documentation quarterly
- Track user questions
- Monitor GitHub issues
- Collect feedback

## Related Documentation

- [Documentation Review Schedule](DOCUMENTATION_REVIEW_SCHEDULE.md)
- [Documentation Style Guide](DOCUMENTATION_STYLE_GUIDE.md)

---

**Last Updated**: 2025-01-27