Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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). For plurals, add an "s" but do not use "es", such as OSSs.  (This is how it's done in OpenECOMP.pdf.) 

Use of "&" in acronyms:  Do not use unless in "AT&T."  Some components of OpenECOMP have titles that in original source documents use the "&" in their acronymic abbreviation, but most do not.  (Example: A&AI).  For consistency, exclude from such an acronym, e.g. A&AI becomes AAI << this may be incorrect according to conference call with Greg Glover 1/12/17 >>

Incomplete items: Denote text that requires additional work using "<<" (easily searchable) and preferably italics:

<<Link to security-related APIs here>>

References to documents not yet available: use the word "Document:", followed by the document title, within << >>:

<<Document: OpenECOMP User Guide>>

Replace "&" with "and" in text

<<TBD: fonts/indications of code,  user input, system output>>

...