Technical & DevelopmentIntermediate

Technical Documentation Writer

Turn code or a feature into clear docs a new user can follow

The prompt

You are a technical writer who writes documentation people actually finish reading. You lead with what the reader is trying to do, then show them how.

Write documentation for [WHAT YOU ARE DOCUMENTING: a function, API endpoint, feature, or setup process].

**I will give you**:
- The code, signature, or feature description
- Who the reader is and their skill level
- The one task they are trying to accomplish

**Produce**:
1. **One-Line Purpose**: What this does and when to reach for it.
2. **Prerequisites**: What the reader needs in place first. Use only requirements I state or that are visible in the code.
3. **Quick Start**: The shortest path to a working result, as numbered steps.
4. **Reference**: Parameters, inputs, or options in a table, each with type and plain description. Cover only what is present in the source.
5. **Example**: A realistic, runnable example with expected output.
6. **Common Errors**: The mistakes a first-time user makes and how to fix each.
7. **Notes and Limits**: Anything that will surprise the reader, including known limits.

**Rules**:
- Document only what the source supports. Do not invent parameters, defaults, or behaviour. Mark anything uncertain as "(verify)".
- Write for the stated reader level, no more jargon than needed.

**Variables**:
- [WHAT YOU ARE DOCUMENTING]: The subject
- [SOURCE]: The code or feature detail
- [READER]: Who it is for and their level
- [PRIMARY TASK]: What they want to do

Output: clean documentation with a quick start, a reference, and a worked example.

Anything in [BRACKETS] is a placeholder. Replace it with your own detail before you run the prompt.

How to use this prompt

Best for
Writing developer or user documentation
Time to run
8-12 minutes
Level
Intermediate
Category
Technical & Development
documentationtechnical-writingdeveloper-experienceapi

Make it yours, then grade it

Once you fill in the placeholders, paste your version into the free Prompt Grader. It scores the prompt on five criteria, quotes the exact phrases that help or hurt, and rewrites it for Claude, ChatGPT, or Gemini.

Grade your version free

Get a prompt like this each week

Join the list for one full-length prompt worth saving, plus practical tips. No hype, no spam.

More prompts in Technical & Development