Skip to content

Documentation style guide

Donna Malayeri edited this page Jan 4, 2018 · 8 revisions

Language and terminology styles

  • Top level headings use Title Case
  • All other headings use Sentence case, where only the first word and any proper nouns have a capital letter.
  • Use capitalization only for a proper noun, and use throughout. For example, "stack" should almost always be lowercase in text

Formatting

  • Use hash marks for headings (#, ##, etc)
  • Use double-asterisks for bold **
  • Use underscore for italic _
Clone this wiki locally