The ONAP Documentation Project maintains a Style Guide.
Here are some basics for contributing on the ONAP Wiki.
Don't worry too much over style. It is better to have good information than none at all! It can always be fixed later if you make a mistake.
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:
- 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 are allowed in Release 1, but going forward, APPC is preferred.
Heat vs HEAT: Both are in use. The official website uses "Heat", but HEAT prevails in reference documents.
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. Note that Reference documents, such as <<DocRef: "Common Requirements for Virtual Network Functions">> show both forms.
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".
open source (adjective): capitalize only in titles; avoid "open-source". (Based on prevalence on the web.)
orchestration: The coordination of facilities and lower-level services in a software-defined networking context to define and provide higher-level services
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 are allowed in Release 1, but going forward, SDNC is preferred.
"secret sauce": replace with a phrase like "value-added functionality" or "vendor-specific algorithms".
subsystem: a large component; avoid "module" when referring to OpenECOMP subsystems such as MSO
...
Acronyms
The following usages apply to specifications for third party software (such as Virtual Network Functions) designed to operate with OpenECOMP. (These definitions are taken from the "Common Requirements for Virtual Network Functions" document.)
must: This word, or the terms required or shall, mean that the definition is an absolute requirement of the specification.
must not: This phrase, or the phrase shall not, means that the definition is an absolute prohibition of the specification.
should: This word, or the adjective recommended, means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
should not: This phrase, or the phrase not recommended, means that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
may: This word, or the adjective optional, means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option must be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option must be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)
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). 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: In general, avoid. Exceptions: "AT&T" and for Release 1, "A&AI". Going forward, "AAI" is preferred.
Currently unavailable sections and references
Incomplete items
:Denote text that requires additional work using "<<TODO:" (easily searchable) and preferably italics:
<<TODO: explain what needs to be done>>
References to documents not yet available
Use : use the word "DocRef:", followed by the document title, within << >>:
<<DocRef: OpenECOMP User Guide>>
Links to documents
Where linking to formal ONAP documentation, link to the specific document or section on the ONAP readthedocs.io site.: if a document is provided in .docx format, attach both the .docx and its generated .pdf to the appropriate page (currently, Reference Documents). Link only to the .pdf.Replace "&" with "and" in text
Special text formatting
...
| Object | Formatting | Example |
|---|---|---|
| source code, user input, program output | Confluence "preformatted" font, or Confluence "Code Block" macro (permits indentation) | contact": { “contactType”: “USER”,“source”: “app1”, } |
Figure numbering and labeling
Start - start with Figure 1 on each page. In the Figure caption itself, use bold for the entire caption; only capitalize the first word:
...
Don't use bold in the text's references to Figure n.
Foreign
Non-English phrases, abbreviations and
...
symbols
Avoid non-English phrases, abbreviations and symbols and substitute as follows:
- e.g.
...
- → "for example", "such as"
...
- i.e.
...
- → "that is" (or rephrase)
...
- via
...
- → "through", or sometimes "by"
- & → "and"
if If you DO use "e.g." and "i.e.", use commas after these.
Keep it simple!
Try to keep sentences 25* words or less. If very lengthy, consider rephrasing and breaking into a bulleted list.
...