← methodology

Quickstart / getting started

usability.quickstart · Usability · 2 pts · recommended

Goal

Is your integration well-built?

Whether your specs, docs, and tools are complete and descriptive enough for an agent to use them without guessing.

How we test

Looked for a quickstart/getting-started guide containing code blocks.

How to pass

Add a copy-pasteable quickstart (auth → first API call) — agents follow it literally.

Verify a fix

curl -X POST /api/scan/checks \
  -H 'content-type: application/json' \
  -d '{"url": "yourdomain.com", "checkIds": ["usability.quickstart"]}'