Reference
Keep documentation current
Find pages and screenshots that need review when the Pūnaha product changes.
Know what can become out of date
A product change can affect a task, result, screenshot, command, limit, or link. It can also change the words used in the interface.
Every Next page lists the product files used as evidence. The documentation evidence record stores a fingerprint for those files.
Use the automatic review signal
Run the product drift check after the product changes. It compares the current product files with the evidence from the last reviewed documentation update.
A changed fingerprint marks the linked pages for review. It does not rewrite, approve, release, or publish a page.
Review a marked page
- Read the changed product source and its tests.
- Follow the task in a safe current build.
- Update only statements that the evidence supports.
- Check every expected result and safe recovery step.
- Keep the existing page address when its purpose has not changed.
- Record the new verification date.
Review screenshots
- Compare each screenshot with the current screen at the same step.
- Take a new screenshot if controls, wording, order, or results changed.
- Use safe example data with no secrets or customer information.
- Crop the image so the action and result are easy to see.
- Write image text that explains the useful information.
A screenshot can remain when the screen and the instruction still match.
Run the documentation checks
The checks cover page details, simple English, image text, headings, internal links, important search words, accessibility support, and package requirements.
They also build the site, search index, and offline files. A failed check must be fixed or recorded as a release blocker.
Complete the human review
Use the accessibility review checklist with a keyboard, small screen, zoom, and a screen reader. Read the changed page as a new user would.
Automation cannot confirm that a screenshot is still true or that an instruction is easy to follow.
Release only reviewed information
Approve updated Next pages after the facts, images, links, search, and accessibility review pass. Follow the version and release guide before creating a release snapshot.
Use the troubleshooting guides to check that recovery advice remains safe.
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.