Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Typos

Table of Contents

Page Location

Product related pages

Pages should be clearly located in the page hierarchy of the respective product

  • Components
  • Features
  • Examples
  • How To
  • FAQ
  • Troubleshooting

Page Titles

Spelling

  • Page titles start with an uppercase letter.
  • The usual lowercase spelling as in any english senctence English sentence is to be used.
  • Terms and product names:
    • Product names are used
    in
    • with their specific spelling.
    • Protocols such as SSH, SFTP etc. are used with uppercase letters.

How to choose a correct title?

How To and FAQ

  • Such pages handle questions and therefore page titles include a closing question mark.
  • Pages for a "How To" section start with the words "How to ..." in the page title.
  • How To articles explain how something is achieved, therefore page titles would not end with a question mark.

FAQ

  • Such pages handle questions and therefore page titles include a closing question mark.

Page Content Structure