Versions Compared

Key

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

...

  • 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:
    • 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)
  • "Order Lifecycle Management"? <<NN>>
  • BSS (Business Support System) and OSS (Operational Support System) - these are standard telecomm industry terms. See Acronyms treatment, below.

  • Lowercase:  "service" "service request" "controllers" (when referring to the explicit 3 in list above, write them out as above. You can say "Application, Infrastructure, and Network Controllers" if you are mentioning all 3 of them at once (likewise for 2 of them) 

Usage

Onboardingonboarding:

  1. taking a Virtual Network Function (VNF) from a source or supplier and integrating it into the OpenECOMP platform
  2. (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 try to use this term to describe avoid - use alternative like workflow and configuration information related to a Resource, Service, Product, or Offer

Orchestrationorchestration:

  1. The coordination of facilities and lower-level services in a software-defined networking context to define and provide higher-level services

run-time vs. execution-time (adjective) - run-time preferred

ingredients: avoid

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.) 

...