Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 1.01 KB

STYLE_GUIDE.md

File metadata and controls

23 lines (14 loc) · 1.01 KB
Raw
layout title permalink
page
Style Guide
/style_guide/

This style guide document outlines some general rules for writing documentation within this repository.

General Rules

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  1. The categories Parameters and Examples MUST be removed if there is no content to be written relating to them.

  2. The categories Description and Examples MUST start with verbs written in past tense.

  3. The category Parameters MUST have each parameter description start with a noun and appropriate article.

  4. Documentation as it relates to verb usage SHOULD avoid usage of generic verbs such as the past tense verbs "Sets" and "Changes".

  5. All phrases and sentences MUST end in a period (.).

  6. Ordinal representations of numbers SHOULD be avoided, such as "first" and "third".