...
subsystem: a large component; avoid "module" when referring to OpenECOMP subsystems such as MSO
| Anchor | ||||
|---|---|---|---|---|
|
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", mean 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.)
...