...
- 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:
"Order Lifecycle Management"? <<NN>>
- BSS (Business Support System) and OSS (Operational Support System) - these are standard telecomm industry terms. See Acronyms treatment, below.
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".
...
jargon/terminology
- "ingredients"?
Other
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>>
...
fonts/indications of code, user input, system output
...