Turn Engineering Notes Into Clear API Documentation

Convert raw technical notes into a structured, professional API endpoint specification including request headers, payload examples, and response codes.

Prompt

Prompt
Act as a Technical Writer. Your task is to transform disorganized engineering notes into a clean, professional API endpoint guide. First, ask me these 3 questions: 1. What is the HTTP method and endpoint path? 2. What is the specific purpose of this endpoint? 3. Please paste your raw notes or technical requirements here. Once I answer, provide the output in the format below. Rules: 1. Use clear, concise language for descriptions. 2. Ensure all JSON examples are valid and properly indented. 3. List every header and field as required or optional. 4. Include one success scenario and two common error scenarios. Output format: # Endpoint Name: [Method] [Path] ## Purpose: [Description] ## Headers: | Header | Value | Requirement |
| --- | --- | --- | ## Request Body: ```json [JSON Payload] ``` ## Success Response (200 OK): ```json [JSON Example] ``` ## Error Responses: ### 400 Bad Request: [Reason] ### 401 Unauthorized: [Reason] This guide is for documentation purposes only and does not replace official compliance checks.

Example output

At a glanceStructure of the login endpoint specificationPOST /v1/auth/login documented section by section
  1. PurposeAuthenticates a user and returns a session token
  2. HeadersContent-Type required, Authorization optional
  3. Request bodyJSON with email and password
  4. Success response200 OKReturns status, token and expires_in of 3600
  5. Error responses400, 401Bad request or unauthorized, with causes

Example for: a user authentication endpoint notes from a backend developer. # Endpoint Name: POST /v1/auth/login ## Purpose: Authenticates a user and returns a session token for subsequent API calls. ## Headers: | Header | Value | Requirement |
| --- | --- | --- |
| Content-Type | application/json | Required |
| Authorization | Bearer <token> | Optional | ## Request Body: json { "email": "user@example.com", "password": "securepassword123" } ## Success Response (200 OK): json { "status": "success", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9", "expires_in": 3600 } ## Error Responses: ### 400 Bad Request: The request body is missing the email or password field, or the email format is invalid. ### 401 Unauthorized: The provided email or password does not match our records, or the account is currently locked due to too many failed attempts.

Written by AI from this prompt. Your results will vary.

Tips and common edits

Why this works

  • Forces a consistent structure that makes technical docs readable.
  • Categorizes requirements into headers for quick scanning.
  • Ensures error handling is documented alongside success paths.

Use this prompt when you have rough notes from a developer meeting or Jira ticket. It works best in ChatGPT, Claude, or Gemini. Paste your raw notes after answering the three initial questions to receive a formatted Markdown specification.

Common edits

  • Add a section for rate limiting if your API has specific thresholds.
  • Include a 'Query Parameters' table if the endpoint accepts URL filters.

Make it repeatable

Keep using this prompt without pasting it in every time.

Keep exploring

More in Writing
Writing

Turn technical specs into a help article

Translate complex technical notes and engineer specifications into a friendly, step-by-step troubleshooting guide that everyday users can follow without confusion.