(DRAFT: Currently this is a mostly a list of possible topics; any style rules are suggestions and not yet agreed to.)
Onboarding:
recipe: OK to use this term to describe workflow and configuration information related to a Resource, Service, Product, or Offer
Orchestration:
jargon/terminology
- "ingredients"?
Acronyms: Write out in first instance on a page, immediately followed by the acronym in parenthesis. Then use the acronym on the rest of the page. In diagrams, if space allows, use full name. Example: Operational Support System (OSS). Plural of acronyms, for instance, to mean "Operational Support Systems." Add an "s" but do not use "es." (This is how it's done in OpenECOMP.pdf.)
Denote text that requires additional work using "<<" (easily searchable) and preferably italics:
<<Link to security-related APIs here>>
Word choice:
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)