SDS Document Tutorial
SDS Document Tutorial
2. System Overview
This section describes the system in narrative form using non-technical terms. This is illustrated
using data flow diagrams which include level zero and level one data flow diagrams.
DFD Level zero diagram (also known as context diagram) shows only a single process (representing
the entire system), and associated external entities.
Data flow level one reveals the general processes and data stores. Figure 2 shows an example of
DFD level one diagram
1
Figure 2: Level 1 DFD
3. System Architecture
In this section, describe the system and/or subsystem(s) architecture for the project based on system
requirement specification document (SRS). Examples of components include: data resources,
users, interfaces, hardware, network etc. Figure 3 and 4, shows some of the components that can be
described in system architecture.
2
Figure4: Components found in a system architecture design
4. Software Design
A software module is the lowest level of design granularity in the system. Depending on the
software development approach, there may be one or more modules per system. This section
should provide enough detailed information about logic and data necessary to completely write
source code for all modules in the system. Include the following information to describe software
designs.
Figure 3 shows an example of pseudo code and corresponding flow chart of a certain system
3
Figure 3: A Pseudocode and corresponding flowchart
4
Additional information may add as required for the particular project. Provide a comprehensive
data dictionary that describes the basic organization of a database. Some of the descriptions include
a list of variables in the database as well as the assigned variable names and a description of each
type of variable (e.g. character, numeric, dates). It should also include the values accepted for each
variable, and any helpful comments such as important exclusions and skip patterns. The data
dictionary is used primarily for data analysis. Table 1shows an example of Data dictionary.
6. Human-Machine Interface
This section provides the detailed design of the system and subsystem inputs and outputs relative
to the user/operator. 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.
Depending on the particular nature of the project, it may be appropriate to repeat these sections at
both the subsystem and design module levels. Additional information may be added to the
subsections if the suggested lists are inadequate to describe the project inputs and outputs.
The section provides the layout of all input data screens or graphical user interfaces (GUTs) (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.
5
It also discusses the miscellaneous messages associated with operator inputs, including the
following:
Copies of form(s) if the input data are keyed or scanned for data entry from printed forms
Description of any access restrictions or security considerations
Each transaction name, code, and definition, if the system is a transaction-based processing
system
(b) System Output Design
This section describes of the system output design relative to the user/operator. System outputs
include reports, data display screens and GUIs, query results, etc. The following should be
provided, if appropriate:
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
Developers of sensitive State systems are required to develop specifications for the following
minimum levels of control:
Internal security to restrict access of critical data items to only those access types required
by users
Audit procedures to meet control, reporting, and retention period requirements for
operational and management reports
Application audit trails to dynamically audit retrieval access to designated critical data
Standard Tables to be used or requested for validating data fields
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.
8. Project References
This section provides a bibliography of key project references and deliverables that have been
produced before this point. Examples: SRS, Proposals etc.
9. Glossary
Supply a glossary of all terms and abbreviations used in this document. If the glossary is several
pages in length, it may be included as an appendix.