Versions Compared

Key

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

Headings

The highest level is Heading 1

...

  • First word on each line of a bulleted list (except for definitions in the Glossary)
  • The following are proper nouns that in many cases have a specific meaning in OpenECOMP and should be capitalized:
    • Application Controller
    • Infrastructure Controller
    • Network Controller
    • Offer
    • Product
    • Resource
    • Service (note: use "service" in generic contexts; use "Service" for a Service Design & Creation tool object)
  • Letters in words that are part of acronyms. See Acronyms treatment, below. Examples:
    • Business Support System (BSS)
    • REpresentational State Transfer (REST)
    • Open Platform for NFV (OPNFV)

Usage

AA&I vs. AAI: Both are allowed in Release 1, but going forward, AAI is preferred.

APP-C vs APPC:  both Both are allowed in Release 1 (consistent with SDN-C/SDNC), but going forward, APPC is preferred. 

Heat vs HEAT: Both are in use. The official website uses "Heat", but HEAT prevails in reference documents.

...

recipe: use alternatives like "workflow and configuration information", when related to a Resource, Service, Product, or Offer. However, within the context of the server configuration system Chef, a recipe is the most fundamental configuration element.

run-time vs. execution-time (adjective): prefer run-time. Example: "run-time logging of events"

run time:(noun) Example: "logging of events at run time"

SDN-C vs SDNC: both Both are allowed in Release 1 (consistent with APPC/APP-C), but going forward, SDNC is preferred.

"secret sauce": replace with a phrase like "value-added functionality" or "vendor-specific algorithms".

...

Use of "&" in acronyms:  In general, avoid. Exceptions: "AT&T" and for Release 1, "A&AI". The latter appears often as Going forward,  "AAI" but both forms are still in use.is preferred. 

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

...