(DRAFT: Currently this is a mostly a list of possible topics; any style rules are suggestions and not yet agreed to.)
Capitalization
- First word on each line of a bulleted list
- The following are proper nouns that in many cases have a specific meaning in OpenECOMP and should be capitalized:
Usage
Onboarding:
- taking a Virtual Network Function (VNF) from a source or supplier and integrating it into the OpenECOMP platform
- (avoid this usage) telling a potential developer/contributor what they need to know about tools, policies, processes, etc. to start using or contributing to Open ECOMP. Instead, use a title such as "Developer Starting Guide" rather than "Developer Onboarding Guide".
recipe: OK to use this term to describe workflow and configuration information related to a Resource, Service, Product, or Offer
Orchestration:
- The coordination of facilities and lower-level services in a software-defined networking context to define and provide higher-level services
jargon/terminology
- "ingredients"?
Other
use of abbreviations and acronyms
fonts/indications of code, user input, system output
Figure numbering and labeling - start with Figure 1 on each page
foreign phrases and abbreviations (avoid, and what to substitute)
-e.g. > for example, such as
- i.e. > that is (or rephrase)
- via (through, or sometimes by)
if you DO use "e.g." and "i.e.", use commas after these
Heading usage (use built in heading defaults that come with Confluence)
- Make sure that they come in sequence, that is, don't just put a 3rd level heading in because "it looks right"-there has to be a 2nd level heading before it.
quote marks - avoid
Try to keep sentences 25* words or less. If very lengthy, consider rephrasing and breaking into a bulleted list.
* Sometimes impossible but worth shooting for.
treatment of certain keywords like “project” (OSS vs. customer vs. ?) (BILL: I am not sure here what this means; please elaborate)