1. STAEDEAN documentation guidelines and processes
  2. Documentation guidelines
  3. General documentation guidelines

Keep it consistent

To keep your documentation consistent:

  • Use consistent styling:
    • Use Bold only to refer to UI elements. UI elements are: menus, forms, tabs, buttons, and fields. It is not mandatory to use bold for UI elements.
    • Use Italic only to refer to a book or document.
    • Use “quotes” only to refer to chapters in documents.
    • Use ‘single quotes’ only to mark data input.
    • In all other cases, just use the normal style.
  • Use consistent capitalization:
    • Only use capitals:
      • At the start of each sentence.
      • At the start of each list entry. 
      • If you refer to UI elements. (Only the first word of a UI element label has a cap! If you see UI labels with all words capitalized, please make sure it is corrected.)
    • In all other cases, capitals are not allowed.
  • Use consistent terminology:
    • Make sure that the terminology in the UI is consistent. Also use this terminology consistently in your documentation.
    • When appropriate, repeat a proper term or wording, even in one sentence or paragraph. Keep in mind that you do not write a novel, but you write to explain something. Therefore, you do not need to be inventive in your phrasing and wording.