This is an old revision of the document!


Design Document

Overview

This should be based on the work stated in the concept document.

Tasks

This is a comprehensive list of tasks the satisfy the requirements. Each task will have it's own section with use case diagrams and functional level of detail.

Example sections are below.

Component

A detailed definition of a component. Think of a component as a single aspect of the overall system. The description of a component will go from the high level of the user interface down to the functions that it implements.

Data Structures

This is a strick definition of the data structures used throughout the system.

User Interface

This is a description of how the user will interact with the software. There should be some comps showing what the UI would look like. If this is a headless component, document the exposted functionality. For example is it commandline and what are the arguments, or is it a library and what are the functions. This section will also contain the use case diagrams.

Task Schedule

Reference to the project managment software (dotproject). Possible house the gant chart.

Closing Statement

design/gen_proc/design_doc.1270758646.txt.gz · Last modified: 2020/11/19 14:21 (external edit)
Back to top
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0