Document conventions
Purpose
This is a project about the ABC Pty Ltd which is a small technology company which is a startup company which is located in Sydney Australia. The company deals with the providing services between the trades men and customers and currently they handle their records manually which is much tedious, time consuming and involve much risks of data loss. Therefore the major purpose of this project is to prepare the system requirements specification document for the proposed web or app system that will facilitate smooth operations in the company between the trade’s men and the customers and this system will also ease advertisement of jobs, access of jobs and smooth payment through the system.
Document conventions
This project document has various conventions and they have specific meaning and purpose which includes the following:
Conventions |
Descriptions |
Use cases |
This is the various functions that can be done by the system users who are referred to actors. |
Use case diagrams |
This is the diagrammatic representation of the various system use cases. |
Swim-lane diagram |
This is the diagram that indicates various system users and involved processes. |
State-transition diagram |
This is a diagram that represents the various processes and how they start, follow each other and ends. |
Entity relationship diagrams |
This is the diagram that shows how the various system entities are linked to each other where various attributes are also indicated. |
Data dictionary |
This is the tabulated details indicating the database tables, the respective attributes, data types and the constraints. |
Project Scope
This proposed system app/website system project will cover various aspects and they entail the following scope of items:
- The Over-all systems descriptions:
- The identification of system’s features:
- The identification of the system’s data requirements:
- The identifications of the system’s External interfaces requirements:
- The identification of the system’s quality attributes:
- And the identifications of any other system’s requirements:
Product perspective
User classes and characteristics
The proposed system will have various classes that are characterized by the entities and attributes that they consist and they include the following:
The proposed system will require various feature and facilities in which it will be executed in as discussed below:
- Computer systems, laptop or handheld devices.
- Windows operating system for the computers/laptops and android for the handheld devices.
- Computer and laptops with a minimum of 1TB hard disk storage.
- Computer and laptops with a minimum of 2GB RAM memory.
- Computer and laptops installed with Intel dual core processor with a minimum of 2.5 GHZ processor speed.
- Computer and laptops installed with antimalware software.
- Internet access to all users’ devices.
- Computer network to connect all computer, laptops and handheld devices.
- Computer network with installed back up facility.
There are various constraints which will be considered while developing the proposed system and they are collectively involving the designing and implementations constraints as listed here below:
- The proposed system will be fully web based.
- The system will be developed using HTML, PHP, CSS and java script languages.
- The system will be linked to a database system.
- The system database will be developed on SQL server database management system.
- The database will be developed using the SQL codes.
- The system will be hosted on a company web server.
- The system database will be hosted on company database server.
- The system data backup will be done on purchased cloud server backup facilities.
The following are the various assumptions and dependencies made while implementing the proposed system:
- The company has an existing network system.
- The company network has connected computers and laptops devices.
- The network system is connected to internet access devices.
- The company staffs are fully trained before system installation.
- The company had installed database servers on network.
- The company had installed web servers on network.
- The company had purchased cloud backup space.
- The company computer devices are installed with antimalware applications.
Use case diagram
(Tycho, 2014).
Use case 2: login system
ID and Name |
2: login system |
||
Created by |
Member 1 |
Date Created |
29/10/2019 |
Primary Actor |
Customer |
Secondary Actors |
|
Description |
This is where the customer enters username and password to access system in order to post jobs. |
||
Trigger |
Customer want to post job |
||
Preconditions |
Customer is registered in the system. |
||
Post-conditions |
Below are the post conditions. i. Customer has to make payments. ii. Customer has to rate and review the job done. |
||
Normal Flow |
The below is the flow of events: i. Customer registers in system. ii. Customer enters username in login form. iii. Customer enters passwords in login form. iv. Customer click on the login button in login form. v. Customer is redirected on the post job form. |
||
Alternative Flows |
The below is the alternative flow of events: i. Customer registers in system. ii. Customer enters passwords in login form. iii. Customer enters username in login form. iv. Customer click on the login button in login form. v. Customer is redirected on the main page. |
||
Exceptions |
Below are the exceptions: i. Customer cannot access system if he has no internet enabled devices. ii. Customer cannot login if he is not registered. iii. The customer will get error if he use wrong username or password to login. |
||
Priority |
High |
||
Frequency of Use |
High |
||
Business Rules |
Below are business rules: i. Customer must use his own internet enabled device. ii. Customer should not share login details. iii. The customer should regularly update the login details. iv. The customer must logout after using system. |
||
Other information |
n/a |
||
Assumptions |
Below are assumptions made: i. Customer has internet enabled device. ii. Customer can be able to register. iii. Customer can recall his username and password. |
Use case 3: post job
ID and Name |
3: post job |
||
Created by |
Member 2 |
Date Created |
29/10/2019 |
Primary Actor |
Customer |
Secondary Actors |
Trades person |
Description |
This is where the customer enters updating the job on the system after he successfully login system. |
||
Trigger |
Customer want job to be done. |
||
Preconditions |
Below are pre-conditions i. Customer is registered ii. Customer is login system. |
||
Post conditions |
Below are the post conditions. i. Customer has to upload job to be done. ii. Customer has to receive job done. iii. Customer has to make payment for jobs done. iv. Customer has to rate and review job done. |
||
Normal Flow |
The below is the flow of events: i. Customer registers in system. ii. Customer login in system. iii. Customer post jobs. iv. Customer browse available trades person’s profiles. v. Customer contacts trades persons. |
||
Alternative Flows |
The below is the flow of events: i. Customer registers in system. ii. Customer login in system. iii. Customer enters jobs details. iv. Customer submit jobs details v. Customer browse available trades person’s profiles. vi. Customer contacts trades persons. vii. Customer assign jobs to trades persons. viii. Customer logout system. |
||
Exceptions |
Below are the major exceptions: i. Customer cannot login system with wrong login details. ii. Customer cannot submit empty job entry form. iii. Customer cannot browse available trade’s person unless he is login system. |
||
Priority |
High |
||
Frequency of Use |
High |
||
Business Rules |
Below are business rules: i. Customer must use his own internet enabled device. ii. Customer should not share login details. iii. The customer should regularly update the login details. iv. Customer should make payments after job done using visa card or payment. v. Customer must rate and review the job done. vi. The customer must logout after using system. |
||
Other information |
n/a |
||
Assumptions |
Below are assumptions made: i. Customer has internet enabled device. ii. Customer can be able to register. iii. Customer can be able to login system. |
Use case 8: contact customer
ID and Name |
8: contact customer |
||
Created by |
Member 2 |
Date Created |
29/10/2019 |
Primary Actor |
Trades person |
Secondary Actors |
Customer |
Description |
This is where the tradeperson browses the customer profile and get his contacts, then call him for job allocation. |
||
Trigger |
Customer want job to be allocated the customers’ job. |
||
Preconditions |
Below are pre-conditions i. Trade person is registered ii. Trades person is login system. |
||
Post conditions |
Below are post conditions. i. Trade person perform the tasks. ii. Trade person update the task done. iii. Customer makes payment. iv. Customer rate and review work done. |
||
Normal Flow |
The below is the flow of events: i. Trade person registers in system. ii. Trade person login in system. iii. Trade person browse available jobs. iv. Trade person browse customers profiles. v. Trade person contacts customer |
||
Alternative Flows |
The below is the flow of events: i. Trade person login in system. ii. Trade person browse available jobs. iii. Trade person browse customer’s profiles. iv. Trade person contacts customer. v. Trade person get assigned job to be done |
||
Exceptions |
Below are the major exceptions: i. Trade person cannot login system with wrong login details. ii. Trade person cannot submit incomplete job.. iii. Trade person cannot be paid until he submits the job done. |
||
Priority |
High |
||
Frequency of Use |
High |
||
Business Rules |
Below are business rules: i. Trade person must use his own internet enabled device. ii. Trade person should not share login details. iii. The Trade person should regularly update the login details. iv. Trade person should submit only completed jobs. v. Trade person should receive payment for only submitted jobs done. vi. The Trade person must logout after using system. |
||
Other information |
n/a |
||
Assumptions |
Below are assumptions made: i. Trade person has internet enabled device. ii. Trade person can be able to register. iii. Trade person can be able to login system. |
Logical data model
(Michael, 2017).
Table |
Attributes |
Data type |
Constraints |
Customer |
Customerid Fullname Contact Address Code City |
Int Varchar(50) Varchar(50) Varchar(50) Varchar(50) Varchar(50) |
PK |
Tradesmen |
Tradesmenid Fullname Specialization Contact Address Code City |
Int Varchar(50) Varchar(50) Varchar(50) Varchar(50) Varchar(50) Varchar(50) |
PK |
Jobs |
Jobid Title Description Payamount Duedate Customerid Tradesmenid |
Int Varchar(50) Varchar(50) Varchar(50) Date Int Int |
PK FK FK |
Payments |
Paymentid Description Paymode Amount Jobid Tradesmenid Customerid |
Int Varchar(50) Varchar(50) int int Int Int |
PK FK FK FK |
(Specialist, 2018).
User interfaces
References to user interface standards to be followed
During the development of the proposed system there are various references that were to be followed and they include the following:
- Ensuring there is consistency of the visual elements of the site.
- Ensuring the users expected requirements are meet.
- Putting into consideration of the well established conventions in layout designing.
- To apply the user interface elements that was originally defined.
- Making good choice of the design languge.
The website will be having the times new Romans font type and 12 font size, however the icons used should be small in size not more than 20kb, all the buttons will be labeled with black font color text, the images to be used should be either .jpg format and with size not more than 1mb, and finally the system will have a white background color scheme on the body section while the header and footer will have pink color scheme (Paige, 2015).
The system will be fitting to any screen size with all features visible depending on the type of devices that is used to open the web system (Stephen, 2014).
Project Scope
The system will be having the buttons which will mainly be on login form and data submitting forms, however there will be navigation links on the top of the page and they will link various web pages, the links will be blue in color and the visited links will turn to red color.
The system will have several shortcut keys which includes the following:
- Ctrl+C for copy.
- Ctrl+X for cut.
- Ctrl+V for paste.
- Shift+S for save.
The system should display a message after successful login, successful data storage and error message for data validation.
During the capturing of the data the data must be validated in that the data capture forms should not accept submitting the empty data fields and as a result it should display error message to the user.
The layout of the various interfaces should be well structured where they will have header section on top followed by navigation menu, the centered headings, and the other sub-headings and also the footer section.
The system developed should be having blight color for texts and links for people who are color blind; however the font size for the text should be size 12 and above for the purpose of people with impaired visibility (Thomas, 2013).
The proposed system will be having various software interfaces that facilitate the communication between system components, however among the interfaces include:
- The installed Windows/Mac/Xp/Linux operating system.
- The app instant massager (Shamkant, 2015).
- The internet protocols (IP).
- The software’s driver.
- The e-mail system.
The proposed system will be having various hardware interfaces that will be joined together to facilitate the communication and they include the following:
- The computer buses
- The computer storage devices.
- The computer input and output devices.
- The internet connection router.
- The network connection cables.
Usability
The proposed system will be highly usable in that the implementation will consider the various group of people targeted, therefore various features like font size, the link menus, the scroll menus will be implemented to enable the users to interact and navigate between the contents easily (Ramez, 2015).
Performance
The proposed system will be designed well to ensure that it has high performance which includes the system response time, high level of accuracy, highly efficient and with relatively high speed in execution (Elmasri, 2013).
Security
The proposed system will ensure there is high security where the developers will ensure there is good system authentication, setting of system firewalls, setting system encryption and setting of secure and strong login passwords (Dick, 2018).
Among other additional system requirements includes the following:
- Setting of system back up facilities.
- Frequent updating login details.
References
Dick,B.(2018). IT Project Management Essentials: Information Systems Project Methodology Kindle Edition.New York:Amazon Digital Services LLC.
Elmasri,E.(2013). Database Systems: Models, Languages, Design and Application Programming.India: PEARSON EDUCATION.
Ramez,E.(2015). Database Systems: Models, Languages, Design and Application Programming – International Edition Paperback. India:PEARSON EDUCATION.
Shamkant, B.(2015). Fundamentals of Database Systems.India:pearson.
Thomas,C.(2013). Database Systems: A Practical Approach to Design, Implementation and Management: WITH Success in Your Project. USA:Addison Wesley.
Stephen,H.(2014). Management Information Systems with student CD and MISource. New York:McGraw-Hill.
Paige,B.(2015). Business Driven Information Systems with MISource 2007 and Student CD. New York: McGraw-Hill.
Specialist,I.(2018). CISSP Certified Information Systems Security Professional Study Guide 2018.New York:Independently published
Michael,J.(2017). Human Resource Information Systems: Basics, Applications, and Future Directions.New York :SAGE Publications, Inc.
Tycho,p.(2014). Personal Finance Simplified: The Step-By-Step Guide for Smart Money Management Paperback.New York:Tycho Press.