Terminal
Terminal/Skill
Guides writing or revising a docs page by its content type: tutorial, how-to guide, reference, or explanation.
By InfluxData
Works with
npx skills add influxdata/docs-skills --skill write-docsLoad the gdd-style skill first. Its rules apply to every page. This skill adds the rules that depend on the content type.
Decide the page's content type before you write or revise it. If the page mixes types, tell the writer and suggest a split.
| Content type | The reader wants to | Who acts | Voice |
|---|---|---|---|
| Tutorial | learn by doing | the reader | Imperative steps and "you." One path, no alternatives. |
| How-to guide | finish a task they already understand | the reader | Imperative steps. State each condition before its step. |
| Reference | look up a fact | the system: a server, API, command, or component | Name the component. Passive voice is fine when the actor is unknown or irrelevant. Use "you" only for what the reader supplies or controls. |
| Explanation | understand why something works as it does | the system or the design | Name the component or the decision. Keep reasons and tradeoffs. |
When you revise, gdd-style's fidelity check still applies. Making the reader the actor of a step the source already describes isn't a new claim. Naming a system actor the source doesn't state is.
The page is done when: