api-reference-writing
Steps
- Generate the skeleton from the OpenAPI spec or code.
- Add a working example per endpoint.
- Document errors, limits and auth.
- Test every example.
Done When
- [ ] All examples run
Registry
| id | role | version | status | owner | last_tested |
|---|---|---|---|---|---|
| SK-TECHNICAL-WRITER-api-reference-writing | technical-writer | 0.1.0 | seed | Thomas Cherickal | - |
Links
- Up: Technical Writer skills
- Siblings: docs-information-architecture, docs-style-review
- Frameworks: co-star, few-shot, xml-structured, chain-of-thought
- Tests: testing guide