Docs DEV Release 5.5.4
    Support Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
    1. Product Documentation
    2. /
    3. Scratchpad - Activity Log Updates
    4. /
    5. Documentation One Page Checklist

    Documentation One Page Checklist

    Documentation One-Page Checklist

    Use this checklist before submitting or approving any documentation update.

    1) Purpose and Audience

    • The title states a clear user outcome.
    • The intro explains what the user will accomplish.
    • The page is written for a specific audience (admin, analyst, reviewer, etc.).

    2) Structure and Template

    • The page includes required sections:
      • Purpose
      • When to use
      • Prerequisites
      • Steps
      • Expected result
      • Troubleshooting
      • Related docs
    • Heading levels are in order (H1 -> H2 -> H3).

    3) Procedure Quality

    • Steps are numbered and actionable.
    • Each step starts with a verb.
    • UI labels match the product exactly.
    • Critical steps include expected confirmation.
    • Conditional branches are explicit (if/then).

    4) Accuracy and Completeness

    • The procedure was tested or SME-validated.
    • Inputs, outputs, and assumptions are clear.
    • Edge cases and failure modes are covered.
    • Recovery steps are included for likely errors.

    5) Clarity and Readability

    • Sentences are concise and direct.
    • Paragraphs are short and scannable.
    • Jargon is minimized or defined.
    • Terminology is consistent with other docs.

    6) Callouts and Emphasis

    • Callouts are used only when necessary.
    • Correct shortcode is used:
      • note
      • warning
      • breaking-change
      • migration
      • security
    • Required action appears in the first sentence of warning-level callouts.
    • All links work.
    • Link text is descriptive (not “click here”).
    • The page includes a Related docs section.
    • Next-step links are present for multi-page workflows.

    8) Metadata and Classification

    • Front matter contains required fields (title, weight where applicable).
    • docType is correct (guide or reference) when used.
    • Section placement and navigation weight are correct.

    9) Accessibility and UX

    • Content does not rely on color alone.
    • Tables are used only for true comparison data.
    • Screenshots are cropped and legible.
    • Screenshots do not include sensitive data.

    10) Release Notes and Change Impact (When Applicable)

    • Change summary is clear.
    • Affected audience is identified.
    • Required action is explicit.
    • Deadline and migration path are included when relevant.
    • Breaking changes are clearly marked.

    11) Final Review Gate

    • Spelling/grammar check complete.
    • Style guide alignment confirmed.
    • Reviewer sign-off received.
    • Publish date and owner are set.

    Quick Outcome Check

    If a user lands on this page with a task in mind, can they complete it end-to-end without opening a support ticket?

    • Yes: publish.
    • No: revise before publish.