API Documentation Writer
Turn endpoint behavior into clear API documentation with authentication, parameters, payloads, responses, errors, examples, and implementation cautions.
Prompt
Use the material below to complete **api documentation writer**. The useful outcome is not generic advice; it is a decision-ready result for the query “api documentation writer prompt”. ## Details that matter — API Documentation Writer - [LANGUAGE] — for API Documentation Writer, supply the relevant language. If unavailable, label [LANGUAGE] `unknown`; never infer it. - [EXPECTED_BEHAVIOR] — for API Documentation Writer, supply the relevant expected behavior. If unavailable, label [EXPECTED_BEHAVIOR] `unknown`; never infer it. - [REPRODUCTION_STEPS] — for API Documentation Writer, supply the relevant reproduction steps. If unavailable, label [REPRODUCTION_STEPS] `unknown`; never infer it. - [CODE] — for API Documentation Writer, supply the relevant code. If unavailable, label [CODE] `unknown`; never infer it. - [RUNTIME] — for API Documentation Writer, supply the relevant runtime. If unavailable, label [RUNTIME] `unknown`; never infer it. - [ERROR_OUTPUT] — for API Documentation Writer, supply the relevant error output. If unavailable, label [ERROR_OUTPUT] `unknown`; never infer it. - [REQUIRED_POINTS] — for API Documentation Writer, supply the relevant required points. If unavailable, label [REQUIRED_POINTS] `unknown`; never infer it. - [REPOSITORY_CONTEXT] — for API Documentation Writer, supply the relevant repository context. If unavailable, label [REPOSITORY_CONTEXT] `unknown`; never infer it. ## Method for this job — API Documentation Writer 1. Draft only after locking the audience, purpose, facts, voice, and desired action. 2. Deliver a publishable version plus a compact rationale for important choices. 3. Trace observable behavior through the relevant code path before editing anything. 4. Provide the smallest defensible patch, regression tests, and exact verification steps. 5. Separate confirmed behavior from hypotheses. 6. Consider edge cases, security, and backward compatibility. 7. Show a minimal change before optional refactoring. 8. Include tests that would fail before the correction. 9. Boundary for API Documentation Writer: Do not invent APIs, packages, files, runtime behavior, command output, or successful test results. ## Useful output — API Documentation Writer - **Technical finding for API Documentation Writer** — material inputs for API Documentation Writer, each connected to api documentation writer prompt. - **Evidence or reproduction for API Documentation Writer** — ready-to-use API Documentation Writer, formatted for api documentation writer prompt. - **Minimal change for API Documentation Writer** — API Documentation Writer weak points, unknowns, and api documentation writer prompt limits. - **Test coverage for API Documentation Writer** — api documentation writer prompt → verify API Documentation Writer before use. - **Verification command for API Documentation Writer** — api documentation writer prompt evidence → API Documentation Writer; omit preamble. ## Verification — API Documentation Writer Audit the final API Documentation Writer against the original request. If an essential input is absent, say exactly how that limits the result.
How to use this prompt
Replace only the bracketed fields relevant to your situation. Keep unknown information marked as unknown, paste the completed prompt into a capable AI assistant, and review the result before using it.
Best AI model
ChatGPT • Gemini • capable reasoning assistants

