Template for Reference Docs

Please provide the general information of the reference you elaborate on.

Reference Docs should be comprehensive and accurate

as it is the foundation and source of truth of other docs.

Use plain and succinct sentences in reference docs

to make it more understandable to users.

Use tables to compare things or provide information that categorized in groups

First Item Second Item
Difference A
Difference B

Use lists to provide sequential information

This is an unordered list:

  • Statement 1
    • Sub-statement 1
    • Sub-statement 2
  • Statemet 2
  • ...

This is an ordered list:

  1. First thing
  2. Second thing
  3. ...
Is this page helpful?
Scored Successfully!