Documentation

A typical project has a number of management and engineering documents. As well as being useful for people outside the original development to read, documents can act as a contract.

Engineering Documents

Requirements

Hazard analysis

Specification

Test plan

Code

Management Documents

Contracts

Budgets

Activity charts and graphs

Staff schedules

Methods of Ensuring Sufficient Documentation

High tech: CASE tool

Bureaucratic: Plans and controls dept

Convention: Self documenting code

Email to a friend | Printer friendly version | Link to this page | Terms of Use | Contact Unless otherwise noted, content on this site is licensed under Creative Commons Attribution 2.5
Software_Engineering/Documentation.htm was last modified on 2007-01-02 14:01:15