Technical Writing Style Guide

Azion Docs Technical Writing Style Guide 📝🧡

Welcome to our Technical Writing Style Guide!

This guide defines the style that should be used in Azion Product Education technical communication, helping you write documentation in a clearer way and keep a consistent tone of voice and style. You can rely on it to write and update Azion documentation, whether you're a member of the Product Education team, an Azion member, or a community contributor.

As a principle, we benchmark industry leaders and drive efforts to keep house-specific guiding rules as minimal as possible, adopting proven standards ready for automation and data-driven controls to enforce the style guide. We researched and got inspiration from some of the existing technical style guides and glossaries associated with our industry. To comply with Azion's brand definitions and remain consistent with styles of other areas, we created our own style guide and filtered references aligned with Azion's industry, voice, and style.

The Microsoft Writing Style Guide was selected as our preferred fallback style guide, as well as the Computer Resource Security Center (CSRC) of National Institute of Standards and Technology (NIST) and Linux Foundation State of the Edge (LFEdge) project for technology glossary and terminology.

In short, our style guide considers:

• We doc as a code.
• We have a principle-oriented documentation framework (Diátaxis) to address structure.
• We use an editor integrated with version control (GitHub) to enforce it.
• We set Microsoft Style Guide as its fallback.

Thus, you'll only find explicitly written in this document top-minded rules or, eventually, gaps in the automation process created to help you while editing. Keep in mind that our Style Guide (far beyond this single document) follows the majority of the rules already proven by Microsoft in their Style Guide, with a mixture of our own rules to fit our way of writing and communicating and mainly to fill the eventual gaps that could be found in MS Style Guide.

Always check the online Microsoft Style Guide if you can't find what you were looking for in this document. In case of a complete absence of definitions, get in touch with the Product Education team and management through GitHub issues in this repository.