Skip to main content

Documentation Template

Writing Rules​

  • Do not mention the underlying platform name.
  • Use "training module" instead of "course."
  • Use "register" or "registration" instead of "enroll" or "enrollment."
  • Use only these audience roles when relevant: Users, Department Managers, Company Managers.
  • For administrative tasks, default to Department Manager or Company Manager permissions unless the action clearly fits a User.
  • Navigation paths usually begin with "Management Console" and then the relevant category tab.
  • Do not use inline code formatting for normal documentation text.
  • Do not wrap UI labels, button names, field names, page names, role names, or feature names in backticks.
  • Use quotation marks only when needed for clarity, such as when referring to exact on-screen text.

Overview File Template

Use this shorter structure only when the file is named overview.md or the page title is an overview.

Overview files should only include these sections:

[Title] Overview

Overview​

Briefly explain:

  • What this section or feature area is
  • When someone would use it

Permissions / Access​

Who can access or use this section?

  • Users
  • Department Managers
  • Company Managers

Show the exact path in the platform to reach this feature area.

Example: Management Console -> [Category Tab]

Task-Based File Template

Use this structure for task-based documentation that explains how to complete an action.

[Title]

Overview​

Briefly explain:

  • What this action does
  • When someone would use it

Permissions / Access​

Who can perform this action?

  • User
  • Department Manager
  • Company Manager

Show the exact path in the platform to reach this feature.

Example: Management Console -> [Category Tab] -> [Action]

Steps​

Write each step as a concise numbered action.

  1. Navigate to [location].
  2. Select [button, tab, menu, or option].
  3. Enter [required information].
  4. Select [save, submit, or finish action].

Result​

What should happen after completing this?

  • What the user will see
  • What changed in the system

Notes / Tips​

  • Helpful tips
  • Best practices
  • Gotchas

Troubleshooting​

Common issues and how to fix them

Common issue: [Problem]

Solution: [Fix]

Common issue: [Problem]

Solution: [Fix]

Link to other relevant documentation pages.

  • [Link to related doc]
  • [Link to related doc]