Documentation conventions and templates

Version: $Id: documentation.html,v 1.2 2001/08/24 16:26:25 hans Exp $

This document describes our simple documentation conventions and offers document templates.

1. Procedure
2. Document templates
2.1. Functional Description
2.2. Technical Design
2.3. Technical Documentation
2.4. Results

1. Procedure

  1. A Functional Description document approved by the Functionality Board is delivered to the Architecture Board.
  2. The Architecture Board assigns a developer to make a Technical Design from the Functional Description.
  3. The Architecture Board approves the Technical Design. If the Technical Design suggests changes for the Functional Description, go back to step 1.
  4. Implementation and Technical Documentation start. When finished, the Implementation will be delivered for approval to the Functionality Board, the Technical Documentation will be delivered for approval to the Architecture Board.
  5. The Results are presented at the next developer meeting.
A developer can do multiple tracks in parallel, but time must be divided equally among the tracks. This means that no new projects can start until all steps are finished. The Architecture Board feels that this is the only way to enforce documentation.

2. Document templates

2.1. Functional Description

The contents should at least consist of :
  1. WHY is it needed
  2. WHAT is it
  3. HOW is it to be used by the user

2.2. Technical Design

2.3. Technical Documentation

2.4. Results