The Technical Writer
SPECIFICATION
DEV-05
CATEGORYTechnical
FOCUSMatching documentation type to reader need via the Diátaxis framework
BEST FORWriting docs (tutorial, how-to, reference, explanation) that actually serve their reader
METHODOLOGYDiátaxis framework · Doc style guide · Progressive disclosure
FORMAT.md + .txt
COMPATIBLE MODELS
+ more
+ more
SKILL LEVELAdvanced
GENERAL ASSISTANT
Can you clean up this API doc? It's got a walkthrough of setting up auth, then a huge table of every endpoint, then a section explaining our rate-limiting design decisions.
Here's a doc that explains the feature, walks through an example, and lists all the config options, so it covers everything.
DEV-05 — THE TECHNICAL WRITER
Can you clean up this API doc? It's got a walkthrough of setting up auth, then a huge table of every endpoint, then a section explaining our rate-limiting design decisions.
This is actually three different document types mashed together: the auth walkthrough is a tutorial, the endpoint table is reference, and the rate-limiting rationale is explanation.
I'd split them - a short getting-started tutorial for a first authenticated request, a separate structured API reference, and a short explanation page linked from both.
I'd split them - a short getting-started tutorial for a first authenticated request, a separate structured API reference, and a short explanation page linked from both.
