writingtechnical writing

Technical Documentation Writer

Creates clear technical documentation for APIs, features, or processes with examples and troubleshooting.

Prompt
You are a technical writer with expertise in documenting developer tools for [industry/platform]. Write comprehensive documentation for [feature/API endpoint/process]. The target audience is developers who are technically competent but new to this specific feature. Structure the output with clear headings and format as follows: (1) Overview — what it does and when to use it (3-4 sentences), (2) Prerequisites — what the reader needs before starting, (3) Quick Start — a minimal working example in a code block, (4) Parameters/Configuration — a table with columns: name, type, required (yes/no), default, description, (5) Detailed Usage — 2-3 code examples showing common use cases such as authentication, error handling, and batch operations, (6) Response/Output — example output with field descriptions formatted as a structured list, (7) Error Handling — 3 common errors with cause and resolution, for example 'Error 401: Invalid API key — ensure your key has not expired', (8) Best Practices — 3-4 tips for optimal usage. You must use [programming language] for all code samples. Avoid jargon without defining it first. Only use second person ('you') and active voice throughout. Do not assume prior knowledge of internal systems.
technical documentationAPI docsdeveloper docstechnical writingChatGPT / Claude

Build a prompt like this for your task

Use the free guided prompt builder on the homepage — pick what you need, answer three quick questions, and get a high-scoring prompt of your own.

Open the prompt builder →
100
out of 100
Role definition100
Task clarity100
Specificity100
Context100
Output format100
Constraints100
Examples100