automadocs / features / health-scores.md
00
Feature
Content Health Scores
Know exactly where your technical content stands. Get metrics on coverage, freshness, and quality, with weekly reports to track improvement.
Combined score from 0-100, built from six scored dimensions.
01
Example
What a score looks like
example/my-project
Last analyzed 2 hours ago
78Health Score
- Coverage
- 85%
- Freshness
- 72%
- Completeness
- 76%
3 issues found
- 2 undocumented functions in src/utils
- 1 stale README section
02
Metrics
What We Measure
Six scored dimensions (coverage, freshness, completeness, and more) so you know exactly where to focus
- 01
Coverage Score
Percentage of functions, classes, and modules with written reference notes. Identifies gaps quickly. - 02
Freshness Score
How recently pages were updated relative to code changes. Catches stale guidance. - 03
Completeness Score
Quality of existing coverage: parameters, return types, examples, and descriptions. - 04
Issues Detection
Automatically identifies broken links, outdated examples, missing sections, and inconsistencies. - 05
Weekly Reports
Receive email summaries of score changes, new issues, and prioritized improvements. - 06
Overall Health
Combined score from 0-100 that gives you a quick snapshot of content quality.
03
Why it matters
Why Content Health Matters
- 30%
- of developer time is spent searching for information, per industry research. Good docs reduce this dramatically.
- 50%
- faster onboarding reported by teams that maintain clear, current technical guides.
- 3x
- fewer support tickets commonly seen for well-documented APIs and libraries.
- 2x
- higher adoption rates typical for open source projects with high-quality reference pages.
04
In practice
How Teams Use Health Scores
High-performing teams treat these metrics like test coverage: a leading indicator, not a vanity number. Weekly review of coverage and freshness helps teams catch onboarding risks before they affect releases.
- 01
Review on Release Day
Validate score deltas before shipping major features to reduce stale docs after launch. - 02
Assign Clear Owners
Tie repositories to responsible teams so issues are resolved quickly and not ignored. - 03
Track Trend, Not Snapshot
Use rolling weekly trends to identify systemic drift and prioritize recurring fixes.