System Design Document - Design Specification
System Design Document - Design Specification
System Design Document - Design Specification
FOR
Prepared by
Overview
The System Design Document describes the system requirements, operating environment, system
and subsystem architecture, files and database design, input formats, output layouts, human-
machine interfaces, detailed design, processing logic, and external interfaces.
NOTE: Please insert proper table of contents. Cover page indicating group information is
also required.
1 INTRODUCTION
1.1 Purpose
This section provides a brief description of the Systems Design Document’s purpose.
2 SYSTEM ARCHITECTURE
This section briefly outlines the system software and hardware architecture design of the
system. System architecture diagram should be shown to enhance the understanding of the
reader.
4 USER INTERFACE
This section provides the detailed design of the system and subsystem inputs and outputs
relative to the user. Provide a description of each user class or role associated with the
system. A user class is distinguished by the ways in which users interact with the
proposed system or situation. Factors that distinguish a user class include common
responsibilities, skill levels, work activities, and modes of interaction with the system. In
this context, a user is anyone who interacts with the proposed system, including
operational users, data entry personnel, system operators, operational support personnel,
system maintainers, and trainers. For each user class, provide estimates of the total
number of users anticipated, a maximum number of concurrent users, and the number of
external users. Any additional information may be added to this section and may be
organized according to whatever structure best presents the operator input and output
designs.
4.1 Inputs
This section is a description of the input media used by the user for providing information
to the system, For example, data entry screens, optical character readers, bar scanners, etc.
If appropriate, the input record types, file structures, and database structures provided in
Section 3, File and Database Design, may be referenced. Include data element definitions,
or refer to the data dictionary.
Provide the layout of all input data screens or graphical user interfaces (GUIs) (for
example, windows). Provide a graphic representation of each interface. Define all
data elements associated with each screen or GUI, or reference the data dictionary.
This section should contain edit criteria for the data elements, including specific values,
range of values, mandatory/optional, alphanumeric values, and length. Also address data
entry controls (Validations) to prevent edit bypassing.
SYSTEM DESIGN SPECIFICATION
Discuss the miscellaneous messages associated with user inputs, including the following:
Copies of different form(s) if the input data are keyed or scanned for data entry from
printed forms
Description of any access restrictions or security considerations
Identification of codes and names for reports and data display screens
Description of report and screen contents (provide a graphic representation of each
layout and define all data elements associated with the layout or reference the data
dictionary)
Description of the purpose of the output, including identification of the primary users
Report distribution requirements, if any (include frequency for periodic reports)
Description of any access restrictions or security considerations
5 EXTERNAL INTERFACES
External systems are any systems that are not within the scope of the system under
development, regardless whether the other systems are managed by the State or another
agency. In this section, describe the electronic interface(s) between this system and each of
the other systems, emphasizing the point of view of the system being developed.
enough detailed information about the interface requirements to correctly format, transmit,
and/or receive data across the interface. Include the following information in the detailed
design for each interface (as appropriate):
The data format requirements; if there is a need to reformat data before they are
transmitted or after incoming data is received, tools and/or methods for the reformat
process should be defined
Specifications for hand-shaking protocols between the two systems; include the
content and format of the information to be included in the hand-shake messages, the
timing for exchanging these messages, and the steps to be taken when errors are
identified
Format(s) for error reports exchanged between the systems; should address the
disposition of error reports; for example, retained in a file, sent to a printer, flag/alarm
sent to the operator, etc.
Input control
Access control
Complex update control
Verification processes for additions, deletions, or updates of critical data
Ability to identify all audit information by user identification, network terminal
identification, date, time, and data accessed or changed.
Backup and recovery of the system data
Output control
7 CONCLUSION