Self-Sufficiency Review Checklist

Apply this checklist when reviewing or authoring any product documentation page. The core question to answer is: would someone arriving at this page with no prior context get correct, complete information?

This is especially important for pages about preview features, features behind a flag, and pages with platform constraints. For guidance on writing content that is well-structured for LLM retrieval, see LLM-Friendly Content.

Checklist

Description and Structure

• The page has a non-empty description in front matter that starts with the subject and does not use weak openers (“This article explains…”, “In this guide…”). See Article Structure and LLM-Friendly Content.

• Headings are descriptive, follow a consistent hierarchy with no skipped levels, and do not go beyond level 4.
• The first paragraph identifies the product or feature clearly and states what the page covers without requiring prior context.

Code Examples

• Every code block is preceded by a sentence explaining what the code does, where to run it, and what to expect.
• No code block appears immediately after a heading without introductory text.
• Expected output is shown where it helps confirm success or validate results.

Preview Status and Feature Flags

• If the page documents a public preview feature, the preview: public front matter field is set.
• If the page documents a public preview feature, the include {{% include "public-preview-notice" %}} appears near the top of the page body.
• If the feature requires opting in (such as through the Feature Preview page), that requirement is stated near the top with a direct link.
• The preview status or opt-in requirement does not rely solely on a parent page or overview page to communicate it.

Platform Constraints

• Regional availability restrictions, required plan tiers, or other platform constraints are stated on this page, not only in a related article.
• Known limitations or unsupported operations are documented. Do not link to another page as the sole source of a constraint that affects this page.

Accuracy under Isolation

• A reader who navigates directly to this URL (for example, from a search result or an LLM citation) gets accurate information.
• The page does not assume the reader has read a parent, sibling, or prerequisite page unless that dependency is explicitly stated and linked.