Documentation Style Guide
This Documentation Style Guide is produced and maintained by the Zephyr Project. This section provides overview information about the scope and purpose of this manual and links to related resources.
These guidelines help you write in a manner that is clear, concise, and consistent. Written using ReST, it also contains various use cases for that markup.
Scope
This guide includes the following:
basic
Covers expected writing styles for the project, both general writing guidelines and specific guidelines for step-by-step procedures.
Detailed Writing Style Guidelines
Offers specific examples of guidelines included in the basic. Additionally, it outlines the standards for module-based writing.
Discusses important usage rules to be aware of regarding grammar, mechanics, punctuation, capitalization, abbreviations and other rules to be aware of when authoring and contributing technical content.
Addresses specific writing standards and syntax pertaining to ReST.
About the Documentation Style Guide
Contains information regarding the guidelines above including references, intended audience, and the methodology employed.
This reference manual is written in American English.
Keep in mind that this style guide applies to the following:
- Commit messages.
- Technical presentations.
- Stand alone documents in Restructuredtext.
- In-code comments.
- Release notes.