technical-writing

Use the Diátaxis model to pick one primary purpose: tutorial for learners, how-to for task completion, reference for lookup, or explanation for reasoning. Structure the document around that purpose and link to material serving other purposes rather than mixing them.

Check that the structure serves the reader's task, each instruction includes prerequisites and expected results, and all commands and claims match the actual code. Flag ambiguous modifiers, unclear pronoun referents, and unverifiable statements instead of inventing facts.

Diátaxis divides documentation into four types: tutorials, how-to guides, reference, and explanation. Each serves a distinct reader need, and mixing them in one document reduces clarity, so substantial material of a different type should be split and linked.

It does both depending on authorization. Review requests return findings without edits; when edits are authorized it returns the revised artifact. It never commits, publishes, or changes code as part of a writing task.

Plans, RFCs, PR descriptions, commits, and release notes have their own required formats. Preserve those formats and apply only the sentence-level clarity and accuracy checks to their prose.