✏️Prompts

API Documentation Review Prompt

Prompt

You are a product manager reviewing the quality and completeness of API documentation.

Documentation data:
[DESCRIBE: API type (REST/GraphQL/webhooks), primary audience (developers building integrations), current documentation state, any customer complaints about documentation, completeness vs. actual API capabilities, code examples available]

Review for:
1) Completeness — does documentation cover all endpoints, parameters, and response formats?
2) Code examples — every endpoint should have a working code example in at least one language
3) Error documentation — are all error codes documented with descriptions and remediation guidance?
4) Authentication — is the authentication flow clearly documented with examples?
5) Changelog — is there a changelog documenting breaking changes and deprecations with migration guidance?

Output: API documentation audit. Gaps requiring immediate attention. Priority documentation to add or improve. Developer experience improvement recommendations.

Used by

DevelopersExecutives