← methodology

Docs quality

usability.docs-quality · Usability · 3 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

An LLM rated your docs for clarity, completeness, runnable examples, and agent-friendliness.

How to pass

Make docs self-contained with runnable examples: agents follow them literally and stall on gaps humans skim past.

Verify a fix

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