SRS - oronsa/shoulder2shoulder GitHub Wiki
SRS Document - Software Requirements Specification
Project Information:
- Application name: Accounting Shoulder
- Web Application
- Team:
- Amir Lavi
- Oron Sason
- Shimri Peretz
- Maein Abu Gosh
History Log
(Yet to be)
Table of Contents
- [Introduction] (#introduction)
- [The Main Goal] (#the-main-goal)
- [Scope] (#scope)
- [Glossary] (#glossary)
- [Overview] (#overview)
- [Use Cases] (#use-cases)
- [Actor and Stakeholder Table] (#actor-and-stackholder-table)
- [Main Use Case Diagram] (#main-use-case-diagram)
- [Use Case 1] (#use-case-1)
- [Use Case 2] (#use-case-2)
- [User Stories] (#user-stories)
- [Environment Requirements] (#environment-requirements)
- [Hardware requirements] (#hardware-requirements)
- [Software requirements] (#software-requirements)
- [Additional requirements] (#additional-requirements)
- [User Interface Prototype] (#user-interface-prototype)
Introduction
The Main Goal
The Application "Accounting Shoulder" will be the financial solution for the current technology being used by organization "Shoulder to Shoulder" these days. The purpose of this product is to allow managing reports and saving information regarding the clients' financial state.
Scope
The application will be designed for Web browsers, By DCN Client Server Model
Glossary
(Yet to be)
Overview
- Practical description of the application structure by Use cases and UML chart to allow better understanding of the product.
- Raising possible scenarios in the life of the project development process by discussion brainstorming meeting.
- Learning by user stories by the costumer requirements
- Describing the environment requirements regarding the tools that we're going to use in the developing process.
- User Interface Prototype
Use Cases
###Actor and Stakeholder Table
| Actor | Interests | |
|---|---|---|
| 1 | Employee/Volunteer | System signup, Viewing their proteges status, Massaging and status updates |
| 2 | Family | The underprivileged families, can view/update their status, submit and view reports |
Main Use Case Diagram
Use-Case 1
| Subject | Description |
|---|---|
| Scenario name | Sign up |
| Main actor | Guest/Owner |
| Goal | Employees and families who wants to join the organization |
| Scope | Allowing signing up to the organization |
| Description | Users will be able to join the organization as volunteers or as an underprivileged family |
| Trigger | The users enters the sign up section |
| Prerequisite | None |
| Successful completion conditions | Upon successful submitting, form processing |
| Failure end conditions | Missing parameters |
| Major success scenario | - Enter sign up section - Users fill in the form with all necessary parameters - Click on "Submit form" button - Form submitted successfully - Show status "In process" or "Your report was confirmed by your manager" |
| Extensions and error |
Use-Case 2
| Subject | Description |
|---|---|
| Scenario name | Filling forms |
| Main actor | Underprivileged families |
| Goal difference | The server will process the monthly reports and will provide different views |
| Scope | Monthly report system |
| Description | the underprivileged families will have to fill in a monthly report |
| Trigger | Filling and submitting a monthly report form |
| Prerequisite | Organization member |
| Successful completion conditions | Form sent to server |
| Failure end conditions | Missing parameters |
| Scenario major success | - The family ask to fill a monthly report - User fills form with all the required parameters - Submits form - Form sent successfuly - The form will be processed to different views |
| Extensions (errors) | Failed to submit the form |
User Stories
| User Story | Short Description |
|---|---|
| Analysis report of the finance status | As a family member I wish to fill a monthly report that will help me in the future to manage my account better |
| Send a message between the users | As a user in the system I would like to have the possibility to communicate with others in the application |
| Security system | All the personal information will be protected by a Login system |
Environment Requirements
Hardware requirements
- Server
- Device with Web Accessibility
Software requirements
- Web development IDE (e.g Brackets, SublimeText, WebStorm
- MongoDB
- ExpressJS
- AngularJS
- NodeJS
- Twitter Bootstrap
Additional requirements
- User friendly and easy to operate interface
- Protect sensitive user information
- Data export to external files