Style Guide
Write documentation the Azion way: voice, sentence structure, terminology, formatting, content types, and file conventions.
This guide describes how Azion writes its documentation. Use it when you write a new page, translate one, or review someone else’s work. The rules exist so that every page reads the same way, translates well, and stays useful when a machine retrieves one section alone.
What this guide covers
- Documentation voice: the register every page uses.
- Sentence structure: the sentence rules, adapted from ASD-STE100.
- Procedures: the step grammar every numbered procedure follows.
- Word choice: the vocabulary to avoid and the padding patterns to cut.
- Documentation terminology: product names, the four platform terms, and translation rules.
- Headings, text formatting, code, punctuation, and numbers and units: how content is formatted.
- Content structure: the page kinds and how to pick one, including quickstarts and use cases.
- Information architecture: the thirteen slots a product section can fill, in the order the reader meets them.
- File conventions: frontmatter and bilingual pages.
- Components: the live MDX component set and the rules each one carries.
- How we write the docs: how the documentation is produced, in two languages, for people and agents.
The guide follows its own rules
Every page in this section passes the rules it describes: the sentence caps, the heading rules, and the size targets. When a rule proves unworkable here, the rule changes before any writer is asked to follow it.