AI Reviewer Template: API Documentation Review

A specialist reviewer for developer experience and technical writing teams producing API documentation. This template evaluates endpoint description accuracy, code sample quality and completeness, authentication and authorisation documentation, error handling and response documentation, and overall developer experience. API documentation is often the primary interface between your product and developer users. The reviewer catches common API documentation failures like endpoints with missing or inaccurate parameter descriptions, code samples that do not actually work when copied, authentication flows that are incomplete or unclear, missing error codes and response examples, and documentation structure that forces developers to search extensively for basic information. It ensures your API docs enable developers to integrate quickly and successfully.