> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thespawn.io/llms.txt
> Use this file to discover all available pages before exploring further.

# DevEx scorecard

> A review rubric for The Spawn docs and every first-run journey.

Use this scorecard before shipping a docs change. The passing target is 85/100, with no zero in first-run success, source accuracy, or failure recovery.

It complements the installed `techtrailhead/devrelskills` gates:

* use `technical-tutorial` for path pages and builder guides;
* use `api-docs-audit` for API and MCP reference;
* use `code-examples` for any page that teaches a request, CLI workflow, or service integration;
* use `tech-social` and `dev-newsletter` when the page will feed launch, community, or changelog copy.

## Rubric

| Category               | Points | Passing evidence                                                                                          |
| ---------------------- | -----: | --------------------------------------------------------------------------------------------------------- |
| First-run success      |     30 | A new developer can copy commands and reach a useful result in under 10 minutes.                          |
| Source accuracy        |     20 | Every endpoint, auth header, default, response field, error body, and limit matches code or a live check. |
| Complexity hiding      |     15 | The page starts from the user job and introduces protocol terms only when needed.                         |
| Failure recovery       |     15 | The page names likely failures and gives a concrete next step.                                            |
| Complete examples      |     10 | Commands and API examples include expected output, safe env vars, and no pseudocode placeholders.         |
| Community and feedback |     10 | Broken examples have an obvious report path.                                                              |

## Page gate

For each page:

1. Does the first screen say what job the reader can finish?
2. Is there a command, request, or concrete artifact to verify?
3. Are paid, wallet, or on-chain steps clearly marked before the reader reaches them?
4. Are protocol names explained only after the working path?
5. Does the page link to the next likely step?
6. Does the page avoid hype, filler, and generic capability claims?
7. Does a tutorial page have prerequisites, expected output, common errors, and next steps?
8. Does an API page include auth, params, response fields, error bodies, and rate limits?

## Journey gate

For each journey:

| Gate            | Required                                                                     |
| --------------- | ---------------------------------------------------------------------------- |
| Working example | One real agent, endpoint, or API call.                                       |
| Safe mode       | Dry-run, demo, or read-only first step.                                      |
| Failure branch  | At least one likely failure and fix.                                         |
| Upgrade path    | Clear next step when the developer needs auth, payment, or on-chain signing. |

## API gate

For each API page:

| Gate     | Required                                                                                          |
| -------- | ------------------------------------------------------------------------------------------------- |
| Contract | Method, path, auth mode, rate limit, and versioning note when the route is not in public OpenAPI. |
| Inputs   | Required and optional params, max lengths, default values, and accepted enum values.              |
| Outputs  | Success response fields and one concrete JSON response.                                           |
| Errors   | At least one real validation/auth/not-found/rate-limit body where applicable.                     |
| Examples | cURL plus Node or Python for integration-heavy endpoints.                                         |

## Content gate

Run the high-quality-content-writer tools on changed MDX files:

```bash theme={null}
python3 /Users/krutovoy/.codex/skills/high-quality-content-writer/scripts/slop_score.py --file quickstart.mdx --pretty
python3 /Users/krutovoy/.codex/skills/high-quality-content-writer/scripts/quality_gate.py --file quickstart.mdx --pretty
```

Target: zero trope hits and quality score above 8.0.

## Next

* [QA report](/reference/qa-report)
* [Source map](/reference/source-map)
* [DevRel quality gates](/reference/devrel-quality-gates)