PDF Ebook Software Architecture Design Document
Intending to capture and convey the architectural decisions that have been made in order to implement ProjectPlace, the Software Architecture Design Document (SADD) formally provides a comprehensive overview of the proposed system. It uses a number of architectural decompositions to depict the different aspects, corresponding with the requirements of the Client as portrayed in the SRS.
All requirements with be incorporated into this architectural design, depicting at a high level the appropriate modules, data structures, databases and interfaces. This document serves as a basis for the detailed design, which will establish the design in increased detail.
Contents
- 1 Introduction
- 1.1 Purpose
1.2 Audience (Stakeholders)
1.2.1 The Client
1.2.2 The Supervisor
1.2.3 Team I
1.2.4 440 Auditors/Reviewers
1.2.5 Future Developers of the product
1.2.6 End-Users of ProjectPlace - Administrators and Supervisors
1.3 Scope
- 1.3.1 Document Scope
1.3.2 Product Scope
1.4 Definitions, acronyms and abbreviations
1.5 Existing System
2 Reference Documents
- 2.1 Internal Documents
2.2 Textbooks
2.3 Manuals
2.4 Standards
3 System Overview
- 3.1 Design Process
- 3.1.1 Considerations
3.1.2 Use Case Modelling
3.1.3 Class Modelling
3.1.4 Booch Method
3.1.4.1 Modules
3.1.5 Architecture Pattern
3.1.5.1 The Three-Tier Architecture
4 Decomposition Description
- 4.1 Inputs and Outputs
4.2 Module Decomposition
- 4.2.1 Client Applet Module
4.2.1.1 Description
4.2.1.2 Inputs and Outputs
- 4.2.2 Server Module
- 4.2.2.1 Description
4.2.2.2 Inputs and Outputs
4.2.3 Logger Module
- 4.2.3.1 Description
4.2.3.2 Inputs and Outputs
4.2.4 Common Room Module
- 4.2.4.1 Description
4.2.4.2 Inputs and Outputs
4.2.5 Project Room Module
- 4.2.5.1 Description
4.2.5.2 Inputs and Outputs
4.2.6 Plugin Module
- 4.2.6.1 Description
4.2.6.2 Inputs and Outputs
4.3 Concurrent Process Decomposition
- 4.3.1 Client Process Description
4.3.2 Server Process Description
4.3.3 Client Talker Process Description
4.4 Data Decomposition
- 4.4.1 Data Sharing
4.4.2 Data Storage Overview
4.4.3 User Data Table
4.4.4 ProjUser Data Table
4.4.5 Project Data Table
4.4.6 Plugin Data Table
4.4.7 System Data Table
4.4.8 Log Data Table
5 Dependency Description
- 5.1 Module Dependencies
- 5.1.1 Module: Client Applet
5.1.2 Module: Server
5.1.3 Module: Logger
5.1.4 Module: Common Room
5.1.5 Module: Project Room
5.1.6 Module: Plugin
5.2 Data Dependencies
- 5.2.1 Client Applet - Common Room, Project Room, Module relationship
5.2.2 Database - Common Room, Project Room, Module relationship
6 Use Cases
- 6.1 Login
- 6.1.1 A Valid Scenario
6.1.2 A Invalid Scenario
6.2 Common Room
- 6.2.1 Chat/Post Messages in Common Room
6.2.2 Create Project
- 6.2.2.1 A Valid Scenario
6.2.2.2 A Invalid Scenario
- 6.2.3 Accept/Reject Invitation
6.2.4 Assign Groups
6.2.5 Change Colour Preferences
6.2.6 Enter/Continue Created Projects
- 6.2.6.1 A Valid Scenario
6.2.6.2 A Invalid Scenario
6.2.7 Supervisor Privileges - set Project Group size
6.2.8 Use ProjectPlace Help
6.2.9 Logout
6.3 Project Room
- 6.3.1 Add Decision Log Entry for Action
- 6.3.1.1 A Valid Scenario
6.3.1.2 A Invalid Scenario
6.3.2 Chat/Post Messages in Project Room
6.3.3 Analyse Statistics
6.3.4 Use Project Help
- 6.3.4.1 A Valid Scenario
6.3.5 Exit Project Room
6.4 Administrator Privileges - Administration Interface
- 6.4.1 A Valid Scenario
6.4.2 A Invalid Scenario
7 Sequence Diagrams
- 7.1 Server Startup
7.2 Login
7.3 Common Room Chat
7.4 Group Invitation
7.5 Enter Project Room
7.6 Project Room Chat
7.7 Perform Action
8 Interface Description
- 8.1 Module Interfaces
- 8.1.1 Interaction 1
8.1.2 Interaction 2
8.1.3 Interaction 3
8.1.4 Interaction 4
8.1.5 Interaction 5
8.1.6 Interaction 6
8.1.7 Interaction 7
8.1.8 Interaction 8
8.1.9 Interaction 9
8.1.10 Interaction 10
8.2 Graphical User Interfaces
- 8.2.1 Administration Interface
8.2.2 Other Graphical User Interfaces
9 Glossary
Posted in :
