Promptlight logo
Menu
Back to Prompts

Prompt template

API Documentation Writer

Turn an API contract into task-focused documentation with prerequisites, examples, errors, and clearly marked gaps.

engineering
api
documentation
Write developer-facing API documentation from the supplied contract and verified examples.

Inputs:
- Contract or reference: [API SOURCE]
- Audience and task: [AUDIENCE]
- Authentication and prerequisites: [SETUP]
- Verified requests, responses, and errors: [EXAMPLES]

Organize the page around the user's task. State prerequisites before steps. Explain required and optional parameters, show one minimal working example, and cover common errors and retry behavior.

Return:
1. Purpose
2. Before you begin
3. Request details
4. Minimal example
5. Response explanation
6. Errors and recovery
7. Limits and related operations
8. Documentation gaps

Use consistent terminology and direct language. Do not create sample values that look like real credentials or personal data. Mark any behavior not confirmed by the contract as unknown.

Usage notes

Context, setup, and extra guidance for this prompt.

Customization tips

Turn this into a reusable workflow, not a one-off prompt

  • Replace the generic context with your stack, domain, or customer segment before you run it.
  • Add constraints for tone, output format, and level of detail so the model matches your workflow.
  • Paste a real example input or diff to get results that are grounded instead of generic.
Published July 20, 2026
Source:Method reference: Google developer documentation style guide

Related prompts

Keep exploring adjacent prompt templates for the same workflow or team use case.

engineeringapi

API Contract Reviewer

Review an API contract for consistency, missing behavior, compatibility risks, and testable next steps before implementation.

engineeringdocumentation

Architecture Decision Record Writer

Capture an architecture decision with context, options, evidence, consequences, and a clear condition for revisiting it.

engineering

Acceptance Test Designer

Turn a feature requirement into observable acceptance tests that cover success, failure, permissions, and boundary conditions.

Want to save this prompt for later?

Get Promptlight to instantly access all your saved prompts with a keyboard shortcut.

Download for macOS

Launch, find, and reuse a prompt without leaving your flow

Open Promptlight with a shortcut, search your local Markdown library, then copy the right prompt into any AI tool. These are real screens from the Mac app.

Search mode

Find the right prompt in milliseconds.

Switch via Promptlight icon or ⇧ + Tab

  • Fuzzy search across titles and body text.
  • Favorites and file paths at a glance.
  • Keyboard-first: ↑↓ to navigate, ⏎ to copy.

A prompt library that fits how you already work

Promptlight combines fast local search, portable Markdown storage, and optional enhancement so your best prompts stay useful instead of getting lost in chats.

Lightning-Fast Search

Fuzzy search through your prompts instantly. Find what you need in milliseconds with intelligent matching.

Enhancer Mode

Rewrite a draft after you find it, so saved prompts and rough notes become clearer and easier to reuse.

Keyboard-First Workflow

Every action in Promptlight is keyboard-first. Launch with a shortcut, browse with a shortcut, copy with a shortcut.

Local Prompt Files

Your prompt vault can stay on your Mac as files you control, instead of being stored in another hosted workspace by default.

Edit with Any App

Your prompts are plain Markdown files. Edit them in VS Code, Obsidian, or any editor, and Promptlight picks up the saved changes.

Favorite Prompts

Mark your favorite prompts to pin them for quick access. No need to search for them every time.

Get Started Today

Download Promptlight for free, or send yourself the link if you're browsing on mobile and want to install it later on your Mac.

Download for macOS

Version 1.2.5 • 17.6 MB • macOS 10.13 (High Sierra) or later