Style guides

How DraftStack uses style guides

Style guides give the model concrete writing requirements. DraftStack sends the stored project style guide with each documentation generation call, including rework after reviewer feedback.

Use style guides for terminology, tone, punctuation, formatting rules, and framework-specific conventions.

What to include

• Voice: Use active voice. Write to the reader as you for instructions.

• Structure: Use imperative headings for tutorials and noun phrase headings for guides.

• Commands: Show expected output for commands.

• Punctuation: No em dashes. Use commas, periods, colons, or parentheses instead.

• Terminology: Define product terms, accepted names, and phrases to avoid.

A good style guide tells DraftStack what to preserve, what to avoid, and how to make a generated change look like the surrounding docs.