Customer Documentation Coverage Checklist
Use this checklist to verify customer-facing documentation is complete from an operator perspective.How to use this checklist
- Pick the feature family you are validating.
- Open the linked chapter and confirm all UI actions described there exist in your current workspace.
- Run one functional smoke test for each outcome type in the
Operator validation focuscolumn. - Mark missing guidance, unclear wording, or outdated screenshots for update.
Core product and routing coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| End-to-end operational launch flow | /user-guides/manual/foundations/end-to-end-setup-playbooks | Verify first-workspace launch, routing setup, conversion setup, and analytics validation sequence |
| Link lifecycle (create/edit/archive/restore) | /user-guides/manual/growth/links-and-settings-reference | Verify default destination, status transitions, and archive visibility behavior |
| Campaign lifecycle and grouping | /user-guides/manual/growth/campaigns-cost-and-budget-reference | Verify campaign assignment, campaign-level defaults, and archive behavior |
| Rule logic and priority | /user-guides/manual/growth/rules-conditions-and-operators-reference | Verify first-match behavior, nested condition logic, and fallback handling |
| Security controls on links | /user-guides/manual/growth/links-and-settings-reference | Verify password protection, expiry, click limits, and disabled-state behavior |
| Deep links and fallbacks | /user-guides/manual/growth/deep-links-and-qr-reference | Verify app-open flow on mobile and safe web fallback behavior |
| QR generation and scan reporting | /user-guides/manual/growth/deep-links-and-qr-reference | Verify generated asset quality, scan destination correctness, and attribution |
| Tags, folders, and UTM structure | /user-guides/manual/growth/tags-folders-utm-reference | Verify organization filters and UTM consistency across bulk operations |
| Bulk link operations | /user-guides/manual/growth/bulk-link-operations-reference | Verify import/export safety, validation, and rollback behavior |
Conversion and customer intelligence coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| Conversion setup runbook by channel | /user-guides/manual/data/conversion-tracking-setup-playbook | Verify browser, S2S, and integration ingestion setup with dedupe and identity quality checks |
| Conversion methods and statuses | /user-guides/manual/data/conversion-methods-and-event-types-reference | Verify lead, sale, custom, and non-sale event outcomes are recorded correctly |
| Identity stitching and customer rollup | /user-guides/manual/data/conversions-customers | Verify repeat events merge into the right customer profile |
| Events and customer diagnostics | /user-guides/manual/data/events-and-customers-operations-reference | Verify event-level evidence and customer stitching logic align |
| Revenue/cost normalization and FX | /user-guides/manual/monetization/currencies-cost-models-and-fx | Verify mixed-currency events display correctly in selected reporting currency |
| Attribution context and source mapping | /user-guides/manual/data/conversions-customers | Verify first touch, last touch, and campaign/link relationships are coherent |
| Conversion exports and reconciliation | /user-guides/manual/data/exports-and-operational-checks | Verify export totals align with in-app cards after consistent filters |
Analytics and statistics coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| Workspace analytics tabs | /user-guides/manual/data/analytics-views-reference | Verify Clicks/Leads/Sales/Funnel tabs load and reflect chosen date range |
| Campaign and link analytics drilldowns | /user-guides/manual/data/analytics-and-reporting | Verify scope-level totals match expected subset of workspace totals |
| Default snapshot behavior | /user-guides/manual/data/analytics-and-reporting | Verify first-page cards/tables load quickly and refresh behavior is consistent |
| Exports and data quality checks | /user-guides/manual/data/exports-and-operational-checks | Verify CSV column semantics and reconciliation checks are actionable |
Affiliate, partner, and marketplace coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| Program owner setup and operations | /user-guides/manual/ecosystem/affiliate-program-operations-reference | Verify program setup, partner approval, and commission rules |
| Partner portal workflows | /user-guides/manual/ecosystem/partner-portal-reference | Verify partner auth, invites, enrollments, links, earnings, payouts, and settings |
| Marketplace visibility and applications | /user-guides/manual/ecosystem/affiliate-program-operations-reference | Verify listing visibility, application review, and enrollment outcomes |
| Partner lifecycle and communication | /user-guides/manual/ecosystem/affiliate-program-operations-reference | Verify invites, messages, and partner status transitions |
| Commissions, invoices, and payouts | /user-guides/manual/ecosystem/affiliate-program-operations-reference | Verify approval, payout states, and finance reconciliation |
| Fraud and compliance controls | /user-guides/manual/ecosystem/affiliate-program-operations-reference | Verify suspicious activity handling and escalation runbooks |
Integrations and webhooks coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| Provider-by-provider setup flow | /user-guides/manual/ecosystem/provider-setup-playbooks | Verify Stripe/HubSpot/Slack/Shopify/Zapier/Segment onboarding and validation steps |
| Integration catalog and provider onboarding | /user-guides/manual/ecosystem/integrations-and-automation | Verify connect/pause/disconnect behavior and data ownership |
| Provider-specific settings and mapping | /user-guides/manual/ecosystem/workspace-integrations-reference | Verify provider toggles, mapping fields, and data normalization behavior |
| Ingest pathways (event in) | /user-guides/manual/ecosystem/integrations-and-automation | Verify external conversion ingestion lands in expected entities |
| Delivery pathways (event out) | /user-guides/manual/ecosystem/integrations-and-webhooks-reference | Verify outbound payload delivery, retries, and destination behavior |
| Secret/signature operations | /user-guides/manual/ecosystem/integrations-and-webhooks-reference | Verify signature validation and secret rotation process |
Workspace, settings, and governance coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| Workspace onboarding and governance runbook | /user-guides/manual/workspace/workspace-onboarding-and-governance-playbook | Verify workspace setup order, invite model, and weekly governance routine |
| Members, roles, and invites | /user-guides/manual/workspace/workspaces-and-access | Verify RBAC behavior and access boundaries |
| Workspace settings and defaults | /user-guides/manual/workspace/workspace-settings-and-governance-reference | Verify default currency, timezone, branding, and safety settings |
| Workspace tabs and plan gates | /user-guides/manual/workspace/workspace-tabs-and-plan-gates-reference | Verify visibility and behavior of gated tabs by plan and role |
| Public sharing and embeds | /user-guides/manual/workspace/embeds-and-public-stats-reference | Verify public visibility scope and embed lifecycle controls |
| API keys and app credentials | /user-guides/manual/workspace/api-access-and-scopes | Verify least-privilege scopes and rotation workflows |
| SAML/SCIM (enterprise) | /user-guides/manual/workspace/security-and-compliance | Verify SSO enforcement and provisioning lifecycle |
| Personal account preferences | /user-guides/manual/workspace/settings-and-preferences | Verify default workspace, notifications, and user-level controls |
| Search/support/legal utilities | /user-guides/manual/foundations/search-support-and-legal-reference | Verify search utility, feedback flow, and policy visibility |
Billing, plans, limits, and retention coverage
| Feature family | Documentation chapter | Operator validation focus |
|---|---|---|
| Plan-change validation runbook | /user-guides/manual/monetization/plan-gate-validation-playbook | Verify upgrade/downgrade behavior across tabs, actions, limits, and credits |
| Billing workflows and top-ups | /user-guides/manual/monetization/billing-plans-and-credits | Verify payment method updates and billing history clarity |
| Feature gating and plan limits | /user-guides/manual/monetization/plans-pricing-and-limits-reference | Verify hidden/locked modules and upgrade paths |
| Data retention and lifecycle | /user-guides/manual/data/data-retention-and-lifecycle | Verify soft-delete behavior and retention-window expectations |
| Currency and cost model policy | /user-guides/manual/monetization/currencies-cost-models-and-fx | Verify financial reporting guidance for mixed-currency teams |
Release-readiness check
Run this final pass before publishing docs updates:- Confirm every sidebar item in customer docs maps to at least one workflow in the product UI.
- Confirm every high-impact action has an expected outcome section and a troubleshooting section.
- Confirm every finance metric definition is unambiguous for mixed-currency workspaces.
- Confirm every role-sensitive action calls out permission prerequisites.
- 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.
- Confirm owner assignment remains valid.
- Confirm docs still match current UI labels.
- Confirm newly released features are documented.
- 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