Best Claude Code Prompt for “Write API Documentation”

<verification>
Run the test suite and ensure all tests pass.
Verify that the generated documentation accurately reflects the API endpoint's request and response structures.
Test that the API returns 200 for valid requests and 401 for unauthorized ones.
</verification>
<outcome>
Generate comprehensive API documentation for the provided REST endpoint. This documentation should detail the endpoint's purpose, request parameters (including types, required status, and descriptions), expected request body structure, and possible response codes with corresponding descriptions and body structures.
</outcome>
<context>
Refer to the existing documentation in the `docs/api` directory for style and formatting conventions.
Examine the controller file for the endpoint to understand its current implementation and data handling.
Pay close attention to the request validation and authentication middleware to accurately document their behavior.
</context>
<constraints>
Do not alter the existing API endpoint's functionality or behavior.
Adhere strictly to the OpenAPI Specification (OAS) v3.0 format for the documentation.
Ensure backward compatibility with existing API consumers.
The documentation should be clear, concise, and easy for developers to understand.
</constraints>
<git>
Create a new branch for these changes.
Commit the generated documentation files with a descriptive commit message.
</git>