• Created by Unknown User (rnnavarro), last modified by Unknown User (fay) on Dec 21, 2016

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

(DRAFT: Currently this is a mostly a list of possible topics; any style rules are suggestions and not yet agreed to.)

Capitalization

  • 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" unless specifically referring to

use of abbreviations and acronyms

fonts/indications of code,  user input, system output

figure numbering and labeling

foreign phrases and abbreviations  (avoid, and what to substitute)
     -e.g.  >  for example, such as
     - i.e. >  that is (or rephrase)
    - via  (through, or sometimes by) 

Heading usage (use built in heading defaults that come with Confluence)?
  - Make sure that they come in sequence, that is, don't just put a 3rd level heading in because "it looks right"-there has to be a 2nd level heading before it.

jargon/terminology
  - "recipe"? "ingredients"? 

quote marks - avoid
 



  • No labels