Design Document Specification - Lecture Notes | CSCI 3350, Study notes of Software Engineering

Download Design Document Specification - Lecture Notes | CSCI 3350 and more Study notes Software Engineering in PDF only on Docsity! Design Document Specification Cover sheet containing a. Title ( e.g. Design Document for ETC) b. Submitted to: c. Prepared by: Individuals and organization d. Date Table of Contents Revision History 1. Introduction a. Overview b. Purpose and Scope of the document c. Structure of the document 2. System Overview 3. Design Considerations a. Assumptions b. Constraints c. System environment d. Design methodology e. Risks 4. System Architecture a. Architectural Design b. Design Rationale 5. Component Design a. Static design b. Dynamic design 6. Data Design a. Internal data description b. Global data description c. External data structures d. Data dictionary 7. System Interface Description a. External system interfaces 8. User interface design 9. References Appendix A: Glossary Appendix B: Data Dictionary Appendix C: {Others as required) Annotated Specification 1. Introduction This section provides an overview of the software design document (SDD). a. Overview High-level description of the system and the relationship of this document to the system. b. Purpose and Scope of the document Describe the purpose of this document and its intended audience. c. Structure of the document Describe the format and structure of the remainder of this document 2. System Overview This section describes the high-level overview of the functionality and context of the system 3. Design Considerations a. Assumptions Describe any assumptions, background or dependences of the system, its use operational environment. Anything that you are assuming that directly affects the design. b. Constraints Describe any constraints that have a significant impact on the system. Examples are technology constraints, performance issues, and user characteristics. Also anything the customer has specified, e.g. the system will use MYSQL. c. System environment The hardware and software within which the system must operate and interact. d. Design methodology Briefly summarize the approach used to design the system. e. Risks Briefly describe any risks that have been identified. Include only technical risks, not management, customer, or external environment risks. 4. System Architecture This section describes the high-level system architecture of the system. a. Architectural Design Provide the highest-level view of the system with at least 1 figure, showing the system decomposition into first level subsystems. Describe how the subsystems collaborate to achieve the needed functionality. b. Design Rationale Describe the decisions that were taken in the selection of the architecture. 5. Component Design Describe the decomposition of the subsystems into components. a. Static design Organize this section by subsystems as appropriate. Include functional decompositions or object/class diagrams as appropriate. Describe each class’s responsibilities and describe each method. b. Dynamic design Organize this section by functionality or use case. Describe how the components collaborate to provide the functionality. Include sequence diagrams (and state machine diagrams if appropriate).