Style and grammar guide

Technical documentation should be concise and grammatically correct. It is written on a specific topic and is aimed at a specific reader. The main purpose of this document is to provide guidelines on how to make technical writing clear, concise, consistent and understandable for end users.

Those with a background in journalism will be familiar with the Chicago style manual. This is an indispensable reference for all things  grammar and syntax related, and serves as our point of reference for all grammar-related pain points. However, it isn't specific to the needs of technical writing so this document will include Devo-specific style rules.

This guide covers the core principles of English writing, lists key grammar and punctuation rules, explains how to structure content to improve readability, and provides some useful pointers to make the process of technical writing easier.