# Documentation Review Checklist

{% hint style="info" %}
**How to use this checklist:** Run it before publishing GitBook updates, pricing edits, SDK examples, API changes, or dashboard workflow changes.
{% endhint %}

### Audience clarity

* Non-technical, developer, business, and pricing-reader paths are obvious.
* Each page says who it is for and what the reader will achieve.
* Technical depth is separated from plain-English explanation.

### Product understanding

* The docs clearly explain what PayChainHQ does, who it serves, and what problem it solves.
* Key workflows are explained with expected outcomes.
* Core terms are defined before being used heavily.

### Pricing and gas clarity

* Plans, invoice fees, minimum fees, payout quotas, and Enterprise/custom terms are explained.
* Included gas credits and prepaid gas credits are clearly separated.
* Gas exhaustion behavior is clear: receiving continues, sponsored outbound actions may pause.
* Top-up options and resume behavior are documented.
* Billing renewal, grace period, downgrade, and data preservation are explained.

{% hint style="warning" %}
**Pricing review note:** Pricing and gas-credit language must match the live product. Do not publish “unlimited gas,” “free Enterprise,” or payout automation promises that the product does not support.
{% endhint %}

### Technical completeness

* Authentication, API keys, environments, base URLs, SDK, endpoints, examples, errors, webhooks, retries, rate limits, billing usage, gas credits, and go-live steps are covered.
* Standard API key vs payout API key behavior is clear.
* Webhook verification uses raw body examples.
* Balances, transactions, networks, and tokens are documented as reconciliation/reference surfaces.

### Non-technical usefulness

* Dashboard workflows have step-by-step guidance.
* Pages include expected results and common mistakes.
* FAQs and troubleshooting reduce likely support questions.
* Visuals or diagrams are used where workflows are hard to explain with text alone.

### Security and trust

* API key storage, webhook verification, permissions, irreversible actions, payout controls, billing controls, and go-live checks are explained.
* Docs warn against exposing API keys in browsers or mobile apps.
* Risky operations are clearly labeled.

### Writing quality

* Headings are clear.
* Paragraphs are short.
* Jargon is explained.
* Code examples are copy-pasteable and use placeholder values.
* Pricing examples are easy to audit.
* Warnings and callouts are helpful, not noisy.

### Publishing readiness

* Navigation works.
* Search terms match real user language.
* Links are not broken.
* Examples match current API/SDK behavior.
* Pricing and gas credit language matches the live product.
* Changelog states what changed.
* Ownership is clear for future updates.

{% hint style="success" %}
**Ready-to-publish signal:** The docs are ready when a non-technical operator, a backend developer, and a business stakeholder can each find their path without needing support to translate the page.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.paychainhq.io/paychainhq-documentation-page/security-and-go-live/documentation-review-checklist.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.