Documentation health

A score you can argue with, because it shows its reasons.

Documentation health

Project health aggregates the signals Pulse collects into one number, and then shows you every reason behind it.

Documentation Health: 82/100
✓ 94% of links valid
✓ OpenAPI synced
⚠ 12 pages not reviewed in 12 months
⚠ 4 common searches have no useful result
⚠ 3 API operations may be undocumented

The signals it uses

Signal	Weight
Broken internal links and missing assets	Evidence
API changes that affect a page	Evidence
Overdue reviews	Suspicion
Pages with no owner	Suspicion
Searches that return nothing useful	Suspicion
Negative reader feedback	Suspicion
API operations no page mentions	Suspicion
Unresolved inbox items	Suspicion

Why the reasons matter more than the score

A number on its own is a vanity metric. It goes down, nobody knows why, and people stop looking at it.

Health is built the other way around: the reasons are the feature and the score is a summary of them. Every line is a link to the pages behind it.

Page health

Each page shows:

its Pulse state and every signal behind it;
its owner;
when it was last edited, and by whom;
when it was last reviewed, and when the next review is due;
its views and its helpfulness rating;
the code and API elements it is linked to;

Improving it, in order

Fix the evidence. Broken links and missing assets are facts, and they are the fastest to clear.
Assign owners. A page with no owner cannot be reviewed.
Set schedules on the pages that change with releases.
Work the no-result searches. Each cluster is either a tuning entry or a missing page.
Then look at the number.

Warning

Do not chase the score. A workspace that sets every page to review_every: 365 scores well and documents nothing. The score follows the work.

In your build

staleless check reports the same state from a build, with no browser and no session. See check.