Technical Specification Document

Version Control

Table of Contents

1.Introduction

1.1.Architectural Goals

1.2.Architecturally Significant Requirements

1.3.Constraints

1.4.Interfaces

2.Data Design

2.1.Data Description

2.2.Data Dictionary

2.3.Conceptual Data Model

2.4.Data Conversion

3.Interface Design

3.1.Overview

3.2.Screen Images

3.2.1.<Function Name>

4.Requirements Matrix

1.Introduction

1.1. Architectural Goals

Instructions: Define the architectural goals of the system. How the system will need to adapt over time. What is the expected lifespan of the system, will the system need to respond to technological changes over time, how frequently is the system expected to adapt to change, what changes can we anticipate for the future.

1.2. Architecturally Significant Requirements

Instructions: Identify which requirements are considered architecturally significant. These are things that must be implemented in order to realize the architecture.

1.3. Constraints

Instructions: List the decisions that have been made regarding the approach and constraints being placed on the way the developers build the system. These will serve as guidelines for defining significant parts of the system.

1.4. Interfaces

Instructions: Identify the internal and external systems with which the system must interact. An external system may be anything from software to hardware units that the current system will use, such as printers, terminals, alarm devices, sensors, etc. This could be depicted graphically with a System-Mode Connection Model.

2.Data Design

2.1.Data Description

Instructions: Explain how the information of the system is transformed into data structures. Describe how the major data or system entities are stored, processed, and organized. List any databases or data storage items. This could be depicted through Data Flow Diagrams.

2.2.Data Dictionary

Instructions: Alphabetically list the system entities or major data along with their types and descriptions.

2.3. Conceptual Data Model

Instructions: Provide an Entity Relationship Diagram with the entity types, relationship types, associated attributes, candidate and primary keys, etc. This will be later refined and denormalized into the logical data model.

2.4. Data Conversion

Instructions: Describe if there is any data that will need to be converted over from a legacy system, and the process to convert it, and the tools that will be used to convert the data.

3.Interface Design

3.1.Overview

Instructions: Describe the functionality of the system from the user’s perspective. Keep feature descriptions at a general level. Focus on capabilities needed and why not how they will be implemented.

3.2.Screen Images

Instructions: Provide screen shots showing the interface from the user perspective. These can be hand drawn or can you use PowerPoint, Visio, Word, etc. For each screenshot describe the main functionality of the screen shot and any sub-functions, how the user gets to the screen, the different role access to the screen and the different versions of the screen that different users may see.

3.2.1.<Function Name>

• Description:
• Navigation:
• Role Security:

<SCREEN SHOT HERE>

4.Requirements Matrix

Instructions: Provide a cross-reference that traces components and data structures to the requirements.