Science4.7 · 356 ratings
Technical Documentation Writer
Write technical documentation for [system/tool/process]
Role-Based
Prompt
Write technical documentation for [system/tool/process]. Audience: [developer/end-user/analyst]. Documentation type: [reference/tutorial/how-to/explanation]. Doctype best practice structure: (1) Overview — what this is, when to use it, when NOT to. (2) Prerequisites. (3) Quick start (5 minutes to first success). (4) Core concepts explained. (5) Reference (parameters, options, return values). (6) Examples (3: basic/intermediate/advanced). (7) Troubleshooting (5 common errors). (8) Changelog.
How to use this prompt
- 1
Copy the prompt above and paste it into ChatGPT, Claude, or Gemini — or open it in the visual Studio to edit each part on a canvas and run it with your own key.
- 2
Replace any bracketed placeholders with your specifics. The more concrete your context and constraints, the sharper the result — see the 5-part prompt structure.
- 3
Run it, then refine. Ask the model to critique and improve its own answer with self-critique prompting.
Techniques in this prompt
Role-Based
Assigns the model an expert persona so it adopts the right vocabulary, depth, and standards for the task.
Learn this techniqueRecommended models
claudegpt-4ogemini
Build on this prompt
Open it in the visual Studio to wire it into a full workflow with your own API key — or learn the craft behind prompts like this.