DesignDocumentTemplate

Page header 1

Title page

[ Project Name ] Technical Design Document

I. Introduction
This document sets forth the description of the software solution that meets user ’ s requirements within the constraints of the Audible Core Architecture and Services environment. The design document recounts ’ how ’ the software will work and details the software architecture as well as the conceptual and technical design for the system. Includes description of components as well as data structure and data flows.

II. System Overview
Provide an overview of the system in this section, detailing the subsystems and modules of your system design. Add a brief subsystem and module overview to this section. Include a diagram showing the system structure.

III. Design Description
This section presents the architectural design (see glossary) of your system.

Data Flow/Structure
Describe the important data flow paths of your design and provide a diagram of the flow of data.

Software Structure
A diagram should be included in this section to show the architectural design of your system. The diagram must show the relationship among the subsystems and modules of your system and should provide a hierarchy for control and processing. Remember that "architectural design" includes discussion of data and control flow.

IV. Subsystem and Module Specification
Specify the design for each subsystem and module in your software system. All functions should be described in detail. (Detail means providing a brief description of the subsystem and more detailed information about the modules including a processing narrative, a description of the interface(s) associated with this module, references to other modules used by this module, any data structure internal to the module, and any additional information (comments, restrictions, or limitations) about the module. Feel free to use diagrams in this section to help describe the subsystems/modules.

V. File Structure and Global Data
Describe any information pertaining to database requirements and the types of data that will reside in the database. (Identify data, describe organization of data, specify types of data, note any constraints or valid/invalid ranges of data and any other information you might deem important. This data might be data maintained in a file, database, or in common memory.)

Human-Machine Interface Specification
For example: GUI (graphical user interface) designs

Human-Machine Interface Design Rules
Rules that guide you in the creation of your Interface Design to maintain consistency.

External Interface Design
Interfaces to External Data

Interfaces to External Systems or Devices

Internal Interface Design Rules

Rules that specify how modules, functions, methods, etc. interface with other modules, functions, or methods.

VII. Requirements Cross Reference
List any additional/changed requirements that are identified during the design process. Also provide a cross reference of design to the requirements in the requirements document to show that all the requirements are being met by your design. Discuss any requirements that are not fulfilled by the design.

'''VIII. Document Revision History:'''

This section includes a list of significant changes that have been made to this document after 1.0 version has been submitted for assessment. The revision history should contain a dated list of revisions to the document consisting of: the date of each change, the person responsible for the change, and a description of the change. You should be able to trace changes to the individual who completed the modification. Changes are to be listed in reverse chronological order, recording the following information for changes:

Page footer 1