Skip to main content

Customer Documentation Coverage Checklist

Use this checklist to verify customer-facing documentation is complete from an operator perspective.

How to use this checklist

  1. Pick the feature family you are validating.
  2. Open the linked chapter and confirm all UI actions described there exist in your current workspace.
  3. Run one functional smoke test for each outcome type in the Operator validation focus column.
  4. Mark missing guidance, unclear wording, or outdated screenshots for update.

Core product and routing coverage

Conversion and customer intelligence coverage

Analytics and statistics coverage

Affiliate, partner, and marketplace coverage

Integrations and webhooks coverage

Workspace, settings, and governance coverage

Billing, plans, limits, and retention coverage

Release-readiness check

Run this final pass before publishing docs updates:
  1. Confirm every sidebar item in customer docs maps to at least one workflow in the product UI.
  2. Confirm every high-impact action has an expected outcome section and a troubleshooting section.
  3. Confirm every finance metric definition is unambiguous for mixed-currency workspaces.
  4. Confirm every role-sensitive action calls out permission prerequisites.
  5. Confirm screenshots and naming match the currently deployed dashboard labels.

Documentation ownership model

Use a clear owner for each feature family:
  • Growth owner: links, campaigns, rules, deep links, QR.
  • Data owner: conversions, events, customers, analytics definitions.
  • Affiliate owner: programs, partners, commissions, payouts.
  • Platform owner: integrations, webhooks, API access, security.
  • Admin owner: billing, plans, limits, retention, workspace access.
Quarterly ownership review:
  1. Confirm owner assignment remains valid.
  2. Confirm docs still match current UI labels.
  3. Confirm newly released features are documented.
  4. Confirm deprecated/legacy guidance is removed.

Platform-wide index

  • Module-to-doc mapping: /user-guides/manual/foundations/platform-module-coverage-index
  • Page-level feature map: /user-guides/manual/foundations/feature-map-by-page