Documentation Guidelines

Overview

Maintaining documentation is a perennial problem for any constantly evolving project. The importance of updated documentation for onboarding new developers cannot be overlooked.

Guidelines

General

• Primary location for all documentation should be in the wiki.
• Use hyperlinks liberally.

Developer Tools Installation

• Specify pre-requisites, versions and date validated.
• Use screenshots.