Prompt library / Technical Writing
Technical Documentation Prompt
Generate clear, well-structured technical documentation with this prompt. Works for API docs, README files, and tutorials.
Variables
Replace these placeholders before you run the prompt.
toolOrApiaudiencecomplexityformat
Example inputs
- toolOrApi: REST API endpoint, audience: developers, complexity: intermediate, format: reference guide
- toolOrApi: CLI tool, audience: beginners, complexity: beginner, format: tutorial
How to use
Name the tool or API, audience, and format. Paste real endpoints, flags, or code. The model should not invent parameters.
Prompt
Write {format} documentation for {toolOrApi}.
Audience: {audience}
Complexity: {complexity}
Include:
1. What this is for, in two sentences.
2. Prerequisites.
3. A worked example with inputs and expected output.
4. Parameter or flag reference, only for items you can justify.
5. Error cases and how to recover.
6. Limits and non-goals.
If a parameter, status code, or endpoint is unknown, write TODO instead of guessing.Worked output
For a REST endpoint, expect a purpose paragraph, an example request, a field table, and error handling. Fill TODOs from the real spec before publishing.
Limitations
- The model can still invent facts. Check names, prices, and citations.
- Output quality depends on the model and the values you fill in.
- Do not paste confidential source material into a public model unless that is acceptable.