Design Document:

A design document outlines an implementation that will satisfy the requirements of the SRS. There are many aspects of the system that need to be designed:
o o o

Division of the system into components Communications, APIs and dependencies between components Classes, attributes. operations, and relationships within each component Data representation in the database or files Behavior of each system component Internal APIs for testing and later extensions (e.g., future subclasses) Outline key algorithms and conditions that affect the overall design (otherwise leave that for implementation)

o o o

Many notations are used in design

o o o

Plain English or structured English Many types of UML diagrams Tables, formulas, pseudo-code, other diagrams as needed.

Contents of Design Document:

1. Introduction 1.1. Purpose of this document 1.2. Scope of the development project 1.3. Definitions, acronyms, and abbreviations 1.4. References 1.5. Overview of document 2. System architecture description 2.1. Overview of modules / components 2.2. Structure and relationships 2.3. User interface issues

3. Detailed description of components 3.1. Component overview 3.2. Database 3.3. Class Library 3.3.1. Sub Task 3.3.2. Project 3.3.3. Action Item 3.3.4. Project Note 3.3.5. Time Detail 3.3.6. Project Cost 3.3.7. Entity 3.3.8. Employee 3.3.9. Supervisor 3.4. Reporting Application 3.5. Server Software 3.6. Server Procedure Proxy 3.7. Pocket PC Client 3.8. Desktop Client 4. Reuse and relationships to other products 4.1. Java and Java tools 4.2. Database and Reporting 5. Design decisions and tradeoffs 5.1. Java/.NET Debate 5.2. Three Tier Design 5.3. Schedule 5.4. Projects/Project Items 6. Pseudo code for components

7. Appendices 7.1. Diagrams 7.1.1. System Structure Diagram 7.1.2. User Experience Flow Diagram 7.2. User Interface Screen Designs 7.2.1. Project Entry Screen 7.2.2. Time Entry Screen 7.2.3. Login Screen 7.2.4. Login Failed Dialog 7.2.5. Main Window