Style Guide for Technical Documentation
Set rules for terminology, tone and structure.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
[VERIFY] is an editorial flag, not a blank to fill. Wherever the prompt shows [VERIFY], check that item against a reliable source before you use it.
Create a short style guide for our documentation. Product: [PRODUCT]. Readers: [READERS]. Current inconsistencies I notice: [PROBLEMS]. Existing terms: [TERMS]. Include: voice and tone; sentence length and active voice; headings and capitalisation; how to write steps; terminology table with preferred and avoided terms; formatting for code, buttons and file names; accessibility rules (alt text, link wording, tables); how to show warnings; and a review checklist. Give a before and after example for five rules using invented content. Keep the guide to two pages and mark rules that I must confirm with the team [VERIFY]. Add a short glossary of five style terms with examples, and a list of words to avoid because they are vague, such as simply, just and easy, with replacements. Provide a one-page checklist that an editor can use in five minutes, and a procedure for proposing a change to the style guide. Include a note on inclusive language and plain English for readers who use translation tools.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.