openskills.info
← All skills

Skill map

API documentation

Documents APIs with accurate references, examples, and quickstarts. As Technical Writer needs it.

Careers that require it

Courses that teach it

HOWTOs

Concrete operational procedures from the courses on this page.

  • How to reconcile API documentation with a changed endpoint

    not executable: The procedure requires a live API endpoint in a non-production environment, credentials that exercise the normal and error paths, and a named API owner who can confirm intended behavior. The runner fleet provides none of these, so the steps cannot be executed or verified there.

    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