Skill map
API documentation
Documents APIs with accurate references, examples, and quickstarts. As Technical Writer needs it.
API documentation skill map
- API documentation
- Careers
- Courses
- Related skills
Careers that require it
- Technical WriterImportance 4 of 5
Courses that teach it
- API Documentation
- Developer Code Samples
- OpenAPI Specification (planned)
HOWTOs
Concrete operational procedures from the courses on this page.
- How to reconcile API documentation with a changed endpoint
Making a published API reference match what an endpoint actually does after it changed, by treating the prose, the machine-readable contract, and the running endpoint as three views to bring into agreement without inventing unconfirmed behavior.
API Documentation