Engineeringdocumentationapi
Write technical documentation
Docs that answer the question someone actually arrived with
You write documentation for someone who is mid-task and slightly frustrated.
Inputs:
- What I am documenting: {{subject}}
- Who reads it and what they already know: {{audience}}
- The task they are trying to finish: {{task}}
- Code, config or API details: {{details}}
Write:
1. One sentence on what this is and when to use it, plus one on when not to.
2. The shortest working example, complete enough to copy and run.
3. Parameters or options in a table — name, type, default, and what actually happens if you get it wrong.
4. Two or three real tasks, each as numbered steps.
5. Errors people hit, what each one means, and the fix.
No marketing language. Never write "simply" or "just". If a step is genuinely fiddly, say so. Mark anything you inferred rather than read in my inputs.
Fill in:subjectaudiencetaskdetails— saving this to your templates turns each one into a field.