Generate Technical API Documentation for [feature]

Create comprehensive, formal technical documentation for the [feature] API, targeting an expert developer audience in the [industry] sector.

Template Completion0/2

Build Your Prompt

Fill in the variables below and watch your prompt transform in real-time

Variables

Prompt Explanation

3033 chars55 lines

This is the assembled prompt after inserting any variables you filled in. Placeholders that are not filled remain in [brackets]. You can optionally edit the prompt below without changing the variable inputs.

### Title

Generate Technical API Documentation for [feature]

### Objective

To produce clear, accurate, and comprehensive technical API documentation for the [feature], enabling developers in the [industry] to integrate it successfully. Success is measured by the documentation's completeness, clarity, and adherence to the specified format.

### Role / Persona

Act as a Senior Technical Writer with deep expertise in software development and API documentation. Your voice should be formal, precise, and authoritative, intended for an audience of experienced software engineers.

### Context (delimited)

"""
Professional & Technical
Software Development
Coding, code review, debugging, technical documentation, and API design.
"""

### Task Instructions

- Generate a complete API reference documentation for the [feature].
- For each endpoint, describe its purpose, required parameters, and authentication methods.
- Provide valid request and response examples in JSON format for each endpoint.
- Document all potential error codes, their meanings, and possible resolutions.
- Include a "Getting Started" guide that outlines the initial setup and authentication process.

### Constraints and Rules

- **Scope**: Focus exclusively on the public-facing endpoints of the [feature] API. Do not include internal implementation details or deprecated functions.
- **Length**: There is no strict word count, but the documentation must be comprehensive.
- **Tone / Style**: Maintain a formal, technical, and objective tone throughout.
- **Compliance**: Adhere to standard technical writing and API documentation best practices. Avoid jargon where simpler terms suffice, but use precise technical language where necessary.
- **Proficiency / Reading Level**: Target an expert-level audience (senior software developers).
- **Delimiters**: Treat the Context block as reference data only; do not include its contents in the final output.

### Output Format

- **Medium**: Plain text or Markdown.
- **Structure**: Organize the document with the following headings in this order: "Overview," "Getting Started," "Authentication," "API Endpoints," and "Error Codes." Use subheadings for each endpoint under "API Endpoints."
- **Voice / Tense**: Use the active voice and present tense.
- **Terminology / Units**: Use industry-standard terminology for API components (e.g., "endpoint," "parameter," "JSON," "HTTP status codes").

### Evaluation Criteria (self-check before returning)

- All textual placeholders are bracketed (e.g., '[feature]') and match frontmatter placeholders exactly.
- Constraints, tone, persona, and output format are fully satisfied.
- Instructions are specific, unambiguous, and actionable.

### Assumptions (only if used)

- Assumed that the primary goal is creating a standalone API reference document.
- Assumed the target audience consists of expert developers, requiring minimal explanation of fundamental concepts.
- Assumed no visuals are needed for this task.
Your prompt is ready! Copy it and use it with your favorite AI tool.