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

Compare with Current View Page History

« Previous Version 5 Next »

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

capitalization
   - bulleted lists
   - proper nouns (list of those that are and list of some likely ones that someone might think should be but are not)
     - controllers (lowercase c) and specific ones, such as Network Controller (initial caps)

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