Versions Compared

Key

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

...

  • 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

ingredients: avoid

life cycle vs lifecycle or life-cycle: prefer two words "life cycle", as recommended here, and because OpenECOMP contains a Life Cycle Management (LCM) functionality. 

onboarding:

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

...

Replace "&" with "and" in text

Special text formatting:

ObjectFormattingExample
source code, user input, program outputConfluence "preformatted" font
contact": { “contactType”: “USER”,
             “source”: “app1”,
          }

Figure numbering and labeling - start with Figure 1 on each page

...