Update or create API documentation after making changes to the public interface of an API. Use when modifying existing endpoints, introducing new endpoints, or when API implementation changes are complete and tested.
Specialist guidance for creating clear, accurate, and developer-friendly API documentation.
When encountering ambiguity or needing clarification:
Documentation should be comprehensive enough that a developer unfamiliar with recent changes can successfully integrate with the API using only the documentation.