Design Document Template - 網路前瞻技術實驗室

[Pages:140]Software Development Templates

Design Document Version 0.0

Description of Project

DOCUMENT NO: VERSION:

CONTACT: EMAIL:

Ivan Walsh

DATE:

4/13/2004

Distribution is subject to copyright.

Design Document Template - Chapters Created by: Ivan Walsh

Disclaimers

The information contained in this document is the proprietary and exclusive property of XXX except as otherwise indicated. No part of this document, in whole or in part, may be reproduced, stored, transmitted, or used for design purposes without the prior written permission of XXX.

The information contained in this document is subject to change without notice.

The information in this document is provided for informational purposes only. XXX specifically disclaims all warranties, express or limited, including, but not limited, to the implied warranties of merchantability and fitness for a particular purpose, except as provided for in a separate software license agreement.

Privacy Information

This document may contain information of a sensitive nature. This information should not be given to persons other than those who are involved in the Project Name project or who will become involved during the lifecycle

Trademarks

[Trademarks are added here]

Version History

Version

Author(s)

REVISION CHART Description of Version

Date Completed

Preface

i

Design Document Template - Chapters Created by Ivan Walsh

Document Owner

The primary contact for questions regarding this document is: Author: Project Name Phone: Email:

Document Approval

Document Name: Publication Date: Contract Number: Project Number: Prepared by:

Approval:

__________________________

Name and Organization

Concurrence: _________________________ Name and Organization

ii

Preface

Table of Contents

1 Introduction 1.1 Purpose of this document 1.2 Document Overview 1.3 Identification 1.4 Scope 1.5 Relationship to Other Plans 1.6 References 1.7 Methodology, Tools, and Techniques 1.8 Policies, Directives and Procedures 1.9 Key Stakeholders 1.10 Points of Contact

2 Design Overview 2.1 Background Information 2.2 System Evolution Description 2.3 Technology Forecast 2.4 Application Overview 2.5 Current Process 2.6 Proposed Process 2.7 Business Context 2.8 Constraints 2.9 Risks 2.10 Issues 2.11 Assumptions 2.12 Dependencies

3 Scope of Work 3.1 System-wide design decisions 3.2 System Functions 3.3 Similar System Information 3.4 User Characteristics 3.5 User Problem Statement 3.6 User Objectives 3.7 Performance Requirements 3.8 Security Requirements 3.9 Hardware Interfaces 3.10 Communications Interfaces

Preface

Design Document Template - Chapters Created by: Ivan Walsh

7 7 7 7 7 8 8 8 8 8 8

9 9 9 9 9 9 9 10 10 10 10 11 11

12 12 12 12 12 12 13 13 13 13 13

iii

Design Document Template - Chapters Created by Ivan Walsh

3.11 Software Interfaces 3.12 Design Constraints 3.13 Data Dictionary 3.14 Data Analysis 3.15 Output Specifications 3.16 Decision Tables 3.17 Logical Database Model 3.18 Data Conversion 3.19 Value Definitions 3.20 External System Dependencies 3.21 Data Validation 3.22 Data Migration and Transformation

4 System Design 4.1 System Architecture 4.2 Modules and Interaction 4.3 Data Design 4.4 Internal Data Structure 4.5 Global Data Structure 4.6 Temporary Data Structure 4.7 Database description 4.8 Object-Oriented Design 4.8.1 Object Decomposition 4.8.2 Method Decomposition 4.9 Procedural Approach

5 Detailed Design 5.1 System Structure 5.1.1 Architecture diagram 5.1.2 Alternatives 5.2 Description for Component n 5.2.1 Processing narrative for component n 5.2.2 Component n interface description 5.2.3 Component n processing detail 5.3 Software Interface Description 5.3.1 External Machine Interfaces 5.3.2 External System Interfaces 5.3.3 User Interface 5.4 [Module X] 5.4.1 Data Model 5.4.2 User Interfaces and Functionality

6 Interface Design

iv

13 13 14 14 14 15 15 15 15 16 16 16

17 17 17 17 17 17 17 18 18 18 18 18

19 19 19 19 19 19 19 19 20 20 20 20 21 21 21

22

Preface

6.1 Interface Description

7 User Interface Design 7.1 User interface 7.1.1 Screen images 7.1.2 Objects and actions 7.1.3 Interface design rules 7.2 Components available 7.3 User Interface Development Description

8 Non-Functional Requirements 8.1 Performance 8.2 Security 8.3 Licenses 8.4 Language 8.5 Others

9 Testing 9.1 Test Plan Objectives 9.2 Test Strategy 9.3 System Test 9.4 Performance Test 9.5 Security Test 9.6 Automated Test 9.7 Stress and Volume Test 9.8 Recovery Test 9.9 Documentation Test 9.10 Beta Test 9.11 User Acceptance Test 9.12 Environment Requirements 9.12.1 Data Entry workstations 9.12.2 MainFrame 9.13 Test Schedule 9.14 Control Procedures 9.14.1 Reviews 9.14.2 Bug Review meetings 9.14.3 Change Request 9.14.4 Defect Reporting 9.15 Testing Functions 9.16 Resources and Responsibilities

10 Deliverables 10.1 Schedule

Preface

Design Document Template - Chapters Created by: Ivan Walsh

22

25 25 25 25 25 25 25

26 26 26 26 26 26

27 27 27 27 27 28 28 28 28 28 28 28 29 29 29 29 29 29 29 30 30 30 30

31 31

v

Design Document Template - Chapters Created by Ivan Walsh

10.2 Suspension / Exit Criteria 10.3 Resumption Criteria 10.4 Dependencies

10.4.1 Personnel Dependencies 10.4.2 Software Dependencies 10.4.3 Hardware Dependencies 10.5 Test Data 10.6 Risks 10.6.1 Schedule 10.6.2 Technical 10.6.3 Management 10.6.4 Personnel 10.6.5 Requirements 10.7 Documentation 10.8 Approvals

11 Appendices 11.1 Requirements Traceability Matrix 11.2 Packaging and Installation 11.3 Design Metrics 11.4 Glossary of Terms

Index of Tables

Table 1 -- Risks Table 2 -- Issues Table 3 -- Assumptions Table 4 -- Dependencies Table 5 -- Data Analysis Table 6 -- Decision Tables Table 7-- Value Definitions Table 8 -- External System Dependencies Table 9 -- Roles and Responsibilities Table 10 -- Schedule Table 11-- Approvals Table 12 -- Glossary of Terms

vi

31 31 32 32 32 32 32 32 32 32 32 32 33 33 33

34 34 34 34 34

10 10 11 11 14 15 15 16 30 31 33 34

Preface

1 Introduction

Provide a brief introduction to the system for which this design is being undertaken.

1.1 Purpose of this document

Describe the purpose of the document and its intended audience.

1.2 Document Overview

Outline the main sections in this document, e.g.:

? Chapter 1 ? Describe the contents of this chapter. ? Chapter 2 ? Describe the contents of this chapter. ? Chapter 3 ? Describe the contents of this chapter. ? Chapter 4 ? Describe the contents of this chapter. ? Chapter 5 ? Describe the contents of this chapter.

1.3 Identification

Include a full identification of the system and software to which this document applies, including, identification number(s), title(s), abbreviation(s), version number(s), and release number(s). Identify all standards (ANSI, ISO, IEEE, etc) that apply to the design document.

1.4 Scope

Describe the scope of the design document (and also what is outside of scope); scope of the requirements definition effort and outline the requirements elicitation team, e.g. users, customers, and developers.

Design Document Template - Chapters

? Copyright XXX.

7

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download