Documentation

Guide to documenting Q-CTRL projects


Q-CTRL projects have two types of documentation:

  1. Contributor documentation
  2. User documentation

# Contributor documentation

Contributor documentation is found in the README file and contains only the necessary information for a developer to get started contributing to the project. Q-CTRL follows the standard specified in the Formatting your README GitHub guide. The README file in the Q-CTRL Template repository contains the prescribed structure and instructions on how to apply this standard.

# User documentation

User documentation is found on the Q-CTRL Documentation website. Any means by which a user accesses the platform is supported by user documentation with the aim of making it easy and intuitive to use the software.