Write trustworthy developer reference: drive it from the spec (OpenAPI/AsyncAPI) so it can't drift, make every example runnable, document the unhappy path (errors/limits/auth/pagination), and optimize the quickstart for time-to-first-success.
Scanned 9/23/2026
Skills Directorynpx -y skills add mcorbett51090/RavenClaude --skill api-reference-writing --agent claude-codeInstalls into .claude/skills of the current project.
Are you the author of Api Reference Writing?
Add the live security badge to your README — it updates automatically with every re-scan.
[](https://www.skillsdirectory.com/skills/mcorbett51090-api-reference-writing)More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.
---
name: api-reference-writing
description: "Write trustworthy developer reference: drive it from the spec (OpenAPI/AsyncAPI) so it can't drift, make every example runnable, document the unhappy path (errors/limits/auth/pagination), and optimize the quickstart for time-to-first-success."
---
# API Reference Writing
## Spec-driven
Generate reference from the OpenAPI/AsyncAPI (api-engineering); enrich with prose + examples. It can't drift from the contract that way.
## Examples run
Test every snippet (or extract from tested code). A failing quickstart example is an active trust-destroyer.
## The unhappy path
Document errors (real shapes), rate limits, auth/scopes, pagination, idempotency — needed exactly when the happy path fails.
## Time-to-first-success
The quickstart's job: zero -> a working call in minutes. Optimize it ruthlessly. READMEs answer what/why/how/where.
Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.
No comments yet. Be the first to comment!
