Skip to content

Latest commit

 

History

History
149 lines (119 loc) · 7.78 KB

REQ_s273284.md

File metadata and controls

149 lines (119 loc) · 7.78 KB

Official Requirements Document

Author: Mahtab Niknahad

Date: 29/03/2019

Version: 1

Contents

Abstract

EZGas is a crowdsourcing service that allows users tocollect prices of fuels in different gas stations and locate gas stations in an area, along with the prices they practice

Stakeholders

Stakeholder name Description
Administrator Uses the application to manage purchase and sharing of fuel price. IT Adminstrator, DB Adminstrator
Developer Develops the application. BackEnd , FrontEnd , Infrastructure
Gas Station Uses the application to insert the price of the fuel
User Uses the application to fine the nearest gas station with the lowest price
Google Map it does not use the application. the application uses it's services to collect the location of gas stations

Context Diagram

context-diagram

Interfaces

Actor Logical Interface Physical Interface
Administrator GUI Screen, keyboard
User GUI cellphone
Gas Station GUI Screen, keyboard
Google Maps Web API internet connection

Stories and personas

User 1 : Andy is a university student. the distance from his university to his house is far so he rented a car. Spending money for fuel is important to him because he does not earn so much money from his part time job.

User 2 : Jessica is a teacher , she has 3 children. Every mornings she prepares children for going to school with her. It usually takes time to make her children ready for school so she prefers to choose the nearest Gas station for her car's fuel.

User3 : Stephen has graduated from university recently and he has started his job a month later. He got loan and bought a new car for reaching his office. the price of fuel is important for him because he has a few savings and he pays more than 50 percents of his salary each month for the loan. He works also in nights and he has usually some problems for waking up in the morning so he does not have enough time to go to the cheapest Gas station. He wants a Gas station which is in his path from his house to his office also he wants to know the price of those stations to make a better decision.

Functional and non functional requirements

Functional Requirements

ID Description
FR1 Record the price of fuel in each Gas station
FR2 Record the place of each Gas station
FR3 Show a list of Gas stations can be sorted by the price ascendingly and the nearest location
FR4 Record the location of each user
FR5 Manage Gas stations
FR6 Manage the accounts of users
FR7 Calculate the nearest Gas station with the lowest price
FR8 Show the list of the price
FR9 Produce reports of the price of each Gas station during a year

Non Functional Requirements

ID Type (efficiency, reliability, .. see iso 9126) Description Refers to
NFR1 Usability Application should be used with no training by any users All FR
NFR2 Performance All functions should complete in < 0.5 sec All FR
NFR3 Portability The application runs on mobile devices All FR
NFR4 Portability The application (the reports and data) should be portable from a PC to another PC in less than 5 minutes All FR
NFR5 Maintainability The application should be updated every month for fixing the bugs All FR
NFR6 Reliability The application should show the price correctly All FR
NFR7 Reliability The application should show the direct location of each Gas station All FR

Use case diagram and use cases

Use case diagram

use-case-diagram

Use Cases

Use case 1, UC1 - FR1 Record the price of fuel in each Gas station

Actors Involved Gas station , Google map
Precondition Internet connectivity, Google map service availablity, Account of Gas station has been registered, Logged in into the account
Post condition The price will be added to the DB. It should be updated in the application
Nominal Scenario The Gas station inserts the price of the fuel in the web portal after the registration and login
Variants

Use case 2, UC2 - FR3 Show a list of Gas stations can be filtered by the price and location of the user

Actors Involved User, Gas station , Google map
Precondition Calculate the near Gas stations, Internet connection, availablity of google map service
Post condition Calculate the distance to the selected Gas station , Route the path
Nominal Scenario Shows the list of Gas stations in a particular area. the list can be sorted by the nearest Gas station and price
Variants

Use case 3, UC3 - FR5 Manage Gas station

Actors Involved Administrator , Gas station
Precondition Internet connectivity
Post condition Gas station can be removed
Nominal Scenario Administrator can remove or edit the information of a Gas station
Variants

Use case 4, UC4 - FR9 Produce Reports particularly for each Gas station or Generally

Actors Involved Administrator
Precondition Internet connectivity
Post condition reports of the price of fuel of each Gas station will be available in any document format
Nominal Scenario Administrative can obtain information about the price or Gas stations in any document format
Variants

Relevant scenarios

Scenario 1

Scenario ID: SC1 Corresponds to UC1
Description The Gas station inserts the price of the fuel in the web portal
Precondition Account of Gas station has been registered, Logged in into the account
Postcondition The price will be added to the DB. It should be updated in the application
Step# Step description
1 The Gas station create an account if it does not have.
2 The Gas station login into its account
3 insert or update the price of the fuel

Scenario 2

Scenario ID: SC2 Corresponds to UC1
Description The Gas station inserts the price of the fuel in the web portal , the price is not in a correct format
Precondition Account of Gas station has been registered, Logged in into the account
Postcondition The price will not be added to the DB or updated in the application. shows a warning to the Gas station account
Step# Step description
1 The Gas station create an account if it does not have.
2 The Gas station login into its account
3 insert or update the price of the fuel , the price is not in a correct format
4 Shows warning to the Gas station account