View on GitHub

sdd

Software Design Document a written description of a software product.

Feature Name

Give a general description of the functionality.

Scope

Provide a description and scope of the software and explain the goals, objectives and benefits of feature. This will provide the basis for the brief description of your feature. 

Definitions and Acronyms

Provide definitions of all terms, acronyms, and abbreviations that might exist to properly  interpret the SDD. These definitions should be items used in the SDD that are most likely not known to the audience. 

This section is optional

Architectural Design 

Develop a modular program structure and explain the relationships between the modules to achieve the complete functionality of the system. This is a high level overview of how responsibilities of the system were partitioned and then assigned to subsystems. Identify each high level subsystem and the roles or responsibilities assigned to it. Describe how these  subsystems collaborate with each other in order to achieve the desired functionality. Don’t go into too much detail about the individual subsystems. The main purpose is to gain a general  understanding of how and why the system was decomposed, and how the individual parts work together. Provide a diagram showing the major subsystems and data repositories and their interconnections. Describe the diagram if required. 

Data Design

Explain how the information domain of your system is transformed into data structures. Describe how the major data or system entities are stored processed and organized.

List existing and new tables that relates to this feature. Example:

Table Name New
Sales Header  
Document Reference Yes

Data Flow

Provide information on how data flows through the program, what events are used and how.

User Interface

Describe the functionality of the system from the user’s perspective. Explain how the user will be able to use your system to complete all the expected features and the feedback  information that will be displayed for the user.

Appendices

This section is optional