Documentation PR Checklist

Summary

Use this checklist for documentation pull requests.

Required checks

• [ ] Page type is explicit (Tutorial, How-to, Reference, Explanation).
• [ ] Required metadata is present.
• [ ] Title and headings are descriptive and task-focused.
• [ ] Procedures use numbered steps.
• [ ] Related links are present and useful.
• [ ] Link text is meaningful.
• [ ] Internal links resolve correctly.
• [ ] No broken local links.
• [ ] Terminology matches glossary conventions.
• [ ] Content uses active voice and plain language.

Accessibility checks

• [ ] Heading levels are in logical order.
• [ ] Images with meaning have alt text.
• [ ] Tables include clear headers.
• [ ] Instructions are not image-only.

Visual style checks (DVSS)

• [ ] Parent and child navigation levels are visually distinguishable.
• [ ] Active navigation state is clear in both left nav and page TOC.
• [ ] Heading and paragraph spacing supports quick scanning.
• [ ] Link hover and focus states are visible and consistent.
• [ ] Color contrast remains readable in light and dark modes.

Freshness and ownership checks

• [ ] Owner is assigned.
• [ ] Last reviewed date is updated.
• [ ] Version scope is accurate.
• [ ] Deprecation details are included where needed.

Feature catalog sync

• [ ] Feature catalog links are updated where relevant.
• [ ] Documentation gaps status remains accurate.