Skip to content
karinmarjieh edited this page May 8, 2017 · 47 revisions

SDS - Software Design Specification

Table of Contents

1. Main Product Features & Capabilities:

2. UML Modeling:

4. Non-functional Requirements:


1. Main Product Features & Capabilities

Introduction Document Goals

This document will outline in detail the software architecture and design for Salametcom webapp. It will provide several views of the system's design in order to facilitate communication and understanding the system. It intends to capture and convey the significant architectural and design decisions that have been made for Salametcom.

This document provides the architecture and design of the Salametcom web. It will show how the design will accomplish the functional and non-functional requirements detailed in the Software Requirements Specification (SRS) document.

This document is written on a technical level to address the technical department of the customer that will continue the Salametcom system and the team's technical management.

Capabilities

Description Risk Main Ability
1 Adding an event When the administrator lists an upcoming event on the calendar High
2 Request to volunteer Volunteers request to volunteer in a specific event High
3 Accept the volunteering An administrator accept the volunteer request to volunteer High
4 Sending monthly reports The admin can write,open,edit monthly reports High
5 Donate Donors donate money High
6 Communication Admin can communicate users Medium
7 Sign up Volunteers can sign up Medium
8 Sign in Users and admins can sign in Medium
9 Edit info Users and admins can edit their own information Medium
10 Edit schedule Volunteers can enter the hours they can volunteer according to their schedule Medium
11 Request for volunteer Hospitals can communicate with admins and request for volunteering event Medium

2. UML Modeling

Sequence Diagram

Sequence Diagram

CRC diagram

Class Diagram

Deployment Diagrams

The Uml modeling describe the Physical components that are designed for our application and the type of interfaces between them. Deployment Diagram

3. Persistence

" Still the organization has not decided where to store. "

4. Non-functional Requirements

Software Requirements

The app will include two areas with proper permissions: an area for the volunteers, and an area for management. In the management area there will be an option to send emails and text messages as a group message via an outside service that the organization owns. Our service will produce monthly reports as a summary for the volunteered hours. The required software: visual studio code , mvc5.

Hardware Requirements

A Database that will include the users details, contact information and a calendar that will list the possible dates and hours of volunteering for each volunteer. If the organization prefers to provide us with a server to upload the website on the network. The users will logon using a device that supports a web application.

Additional Requirements

  • The app will load quickly and without malfunctions.
  • The main language of the app should be Arabic.
  • The app will be user friendly.
  • In the event of a malfunction, the app would be able to report the problem.
  • Security - the different areas will be protected.
  • Accessibility - every user will have access only to the appropriate area.
  • Confidentiality - a user who is not an administrator will not be able to view the reports or other users details.

5. Risk Management

Severity, Probability: 1-LOW, 2- MEDIUM, 3-HIGH

Risk Severity Probability Prevention
1 Application load 3 2 Checking load throughout the process of developing, and even after finishing
2 Not finishing the project on time 3 1 Clear division of responsibilities, and always keeping the project manager updated in order to solve any foreseen obstacles
3 Unreliable system information security 3 1 Consult with the course staff
4 Lack of knowledge in some coding languages 2 2 Team members are always there for each other. There's also always the possibility of online learning
4 Sophisticated requirements 1 2 Be honest with the organization representatives about our abilities, and decline in case it isn't something that we can handle
5 Unfamiliarity with the development environment 2 2 Reading online material and consulting with the course staff
6 More resources required for the application 1 1 Check available resources and compare to the requirements of the organization
7 Changes in the requirements document 2 1 Decide on a design rich in components
8 Unsatisfied Client 2 1 Monthly meetings with the organization representatives
9 Code Loss 3 1 Backup the code on cloud

6. User Manual

User Manual Page

7. Test Plan

  • The option to access from any browser.
  • Check the connection between the monthly schedule between the management and the volunteers.
  • General reporting of volunteer and donor information.
  • Server username and password to store the information.

Clone this wiki locally