1 SRS_Structure شرح توضيحي بأمثلة

Download as pdf or txt
Download as pdf or txt
You are on page 1of 9

SRS Structure

1. Introduction

1.1 Purpose
The purpose of this document is to specify the system requirements and the overall description of the
concept of this project. It contains the constraints of the system, the system functionality using
diagrams. It also contains the user and system interfaces. In addition, Logical database design is
specified by ER and Class diagrams. This document is an initial reference for developing the first version
of the system for development team.

1.2 Scope
This software system will be an online academic portal for any university wishing to manage their
academic needs online. More specifically to design and develop a simple and intuitive system which
shall cater the academic needs of any institute. The system shall provide features to the user of an
educational institute to be part of different types of groups, share data and documents amongst
different users, have discussion threads, instant notifications via email/message, assignment
submissions, blogs, share old papers, availability of books and other useful stuff (buy/sell), online
survey . . etc.

1.3 Definitions, Acronyms, and Abbreviations


Acronyms and Abbreviations:
a. PIMS: Personal Investment Management System.
b. SRS: Software Requirements Specification.
c. WWW: World Wide Web.
d. GUI: Graphical User Interface.
Definitions:
a. Transaction: A real event that involves flow of personal money. In the context of shares, it is
buying/selling a group of shares of the same company, and in context of Bank it is
deposit/withdrawal of money to/from one’s account.
b. Security: A set of all transactions pertaining to a company share or a bank account.
c. Portfolio: A set of Securities.
d. Net-Worth: The sum-total of all the money of the investor in form of shares and bank balances.

1.4 References
[1] IEEE 830 Template.
[2] IEEE Guide for Software Requirements Specifications," in IEEE Std 8301984 , vol., no., pp.126, Feb.
10 1984, doi: 10.1109/IEEESTD.1984.119205, URL:
[3] Appendix C of Don Widrig, Dean Leffingwell, “Managing Software Requirements: A Unified
Approach,” AddisonWesley Professional, Release Date: October 1999, ISBN: 0201615932.

1
1.5 Overview
The rest of this SRS is organized as follows: Section 2 gives an overall description of the software. It
gives what level of proficiency is expected of the user, some general constraints while making the
software and some assumptions and dependencies that are assumed. Section 3 gives specific
requirements which the software is expected to deliver. Functional requirements are given by various
use cases. Some performance requirements and design constraints are also given. Section 4 gives some
possible future extensions of the system. Finally, the appendices in Section 5 describe respectively the
formula for ROI calculation for shares and user screen.

2. Overall Description

2.1 Product Perspective


PIMS is intended to be a stand-alone product and should not depend on the availability of other
software. It should run on both UNIX and Windows based platform.
The CISWAAD encompasses numerous files and information from the Alumni Database, as well as files
on the department server system. This system will be completely web-based, linking to CISWAAD and
the remote web server from a standard web browser. An Internet connection is necessary to access
the system.
The Free Forms Reporting application enables the user to create report layouts and export them in
different document formats. The software is intended to be used as an add-on feature for the 86++
product family.

2.2 Product Functions


System Use cases:
1) Login: User logins to the system.
2) Registration: A nonmember user registers to the system.
3) Follow: A member user follows another member to get posts about them.
4) Unfollow: A member user unfollows another member user followed before.
5) Edit Profile: A member user edits their profile information.
6) Comment: A member user comments on a post in the system.
7) Like: A member user likes a post in the system.
8) Unlike: A member user unlikes a post in the system.
9) Share a Quote: A member user shares any quote they have visibility to.
10) Block a User: A user blocks another user to stop communication with them.
11) Send Message: A member user sends a message (text or media) to another member.
12) Report: A user reports another user in case of an abuse or any breach of rule.
13) Settings: A user changes settings of their account or general settings of application.
14) Book Exchange: A user either offers their book for an exchange or searches a book.
15) Logout: A user logs out from the system.
2
2.3 User Characteristics
a. The user should be familiar with the Investment Management related terminology like
Portfolio/Security/Transaction.
b. The user should know the details of a transaction.
The Main Actors:
The users can be separated into groups:
Supervisors:
Users who create a report layout
Analysts:
Users who just analyze reports.
2.3.1 Students
Students are the primary consumers of an academic portal. They are accessing information posted by
professors, uploading assignments and project files, and discussing concepts.
2.3.2 Professors
Professors are the primary content administrators of an academic portal. They are uploading files, links,
and multimedia, and grading assignments in addition to creating new places for students to discuss and
collaborate.
2.3.3 System Administrators
System administrators are primarily responsible for maintaining the academic portal. They contribute
minimally to the courses themselves, but spend more time modifying the system’s configuration and
making appropriate updates.

3
2.4 General Constraints
▪ The Free Forms Reporting application shall run on the existing hardware without any additional
hardware or software requirements.
▪ The Free Forms Reporting application shall run on the existing hardware without any additional
hardware or software requirements.
▪ The system will be intended to run on Firefox 4 and above, Google Chrome 10 and above and
Internet Explorer 8 and above.
▪ Using this system is fairly simple and intuitive. A user familiar with basic browser navigation skills
should be able to understand all functionality provided by the system.
▪ For full working PIMS requires Internet connection.
▪ PIMS is single-user software.
▪ For forend side Android Studio, for backend side Eclipse integrated development environment
have been used. The codes have been written in Java. Also, the application has OpenCV library
and Tesseract engine. For the server side of the application, Google App Engine which is a
platform for developing and hosting web applications in Google-managed data centers has been
used. For database, MySQL server has been set up using the Google Cloud SQL service.

2.5 Assumptions and Dependencies


▪ Full working of PIMS is dependent on the availability of Internet connection.
▪ The downloading of share prices in PIMS is customized to www.indiainfoline.com.
▪ PIMS would not work for any other website.
For a fully functioning QuoteShot application, the following criteria are needed:
▪ The user should have smartphone.
▪ Smartphone’s OS should be Android.
▪ Smartphone’s camera should work properly.
▪ Smartphone’s GPS should work properly.
▪ Smartphone should have internet connection.
Most of the academic portals have a lot of redundant features which are rarely used in academic
sessions. Our new system focuses on the features which are most important to the users of an
academic institute along with introduction of some new features which other portals lacks.

3. Detailed Requirements

3.1 External Interface Requirements


3.1.1 User Interfaces
▪ There has to be a single graphical user interface to create, edit, view and export the reports. All
user interaction shall be based on the select-and-command paradigm. The user shall first select
the item to operate on and then choose the operation either through a drop-down or popup
menu or through a button to press. In addition, the specifications of the 'User Interface Design
Guidelines' are to be applied.
4
▪ The new system shall provide a very intuitive and simple interface to the user and the
administrator, so that the user can easily navigate through pages, assignments, groups and sub-
groups, start discussion threads, blogs, survey, upload assignments, share data, old papers
sharing and the administrator can easily manage groups and revoke user permissions.

3.1.2 Hardware Interfaces


This application will work on android phones and tablets. Android devices must have an internet
connection in order to run this application. Also since the application based on sharing quotes from
books, user can take a photo using camera of the mobile phone and for book exchange a GPS unit must
be available in the mobile phone.
a) Server side: The web application will be hosted on a web server which is listening on the web
standard port, port 80.
b) Client side:
Monitor screen – the software shall display information to the user via the monitor screen.
Mouse – the software shall interact with the movement of the mouse and the mouse buttons. The
mouse shall activate areas for data input, command buttons and select options from menus.
Keyboard – the software shall interact with the keystrokes of the keyboard. The keyboard will input
data into the active area of the database.

3.1.3 Software Interfaces


Since this application is a mobile application, it needs an Android version 4.0 or higher in order to
perform. System has another software product which is the network software
between database and QuoteShot which is not visible by users. This interface is done via secure
network protocols and TCP transport layer application.
a) Server side: An Apache web server will accept all requests from the client and forward it accordingly.
A database will be hosted centrally using MySQL.
b) Client side: An OS which is capable of running a modern web browser which supports JavaScript and
HTML5.

3.1.4 Communication Interfaces


The application will use HTTP protocol for communication over internet. The server will be connected
to the internet through the Wifi or 3G.
The HTPP or HTTPS protocol(s) will be used to facilitate communication between the client and server.

5
3.2. Functional Requirements
We describe the functional requirements by giving various use cases.

6
7
3.3 Performance Requirements
The system should generate the records in the appropriate table of the Alumni Database 100% of the
time.
The system should support at least 200 concurrent users. This statement provides a general sense of
reliability when the system is under load. It is important that a substantial number of users be able to
access the system at the same time, since an academic portal is important to the courses that employ
it. The times when the system will be under the most stress are likely during assignment submissions.
Therefore, it must be able to handle at least 200 concurrent users.
3.2.3.1 Req 046
QuoteShot will be able to support at least 5.000 users. The capacity can be extended in future if needed.
3.2.3.2 Req 047
All of the functions that is for retrieving messages, friends lists, posts on the wall of the places etc.
should be perform less than 3 seconds.
3.2.3.3 Req 048
There will be large amount of information to be handled in database such as messages, profile
information, quotes etc. and the server will be enough space to handle this occupation.
(a) Should run on 500 MHz, 64 MB machine.
(b) 90% of the responses should be within 2 sec, except for downloading current prices for which more
time is acceptable.

3.4 Design Constraints


1. Security: The files in which the information regarding securities and portfolios should be secured
against malicious deformations.
2. Fault Tolerance: Data should not become corrupted in case of system crash or power failure.
1. The communication between the portal software and the database will be in SQL.
2. The portal layout will be produced with HTML/CSS.
3. The product will be written in PHP.
4. The output must be compatible with W3C XHTML 1.0
5. The source code must follow the coding conventions of PHP.
6. System administrators must have access to comprehensive documentation.

3.5 Attributes
3.6 Software System Attributes:
The software consists of the following elements:
1. The apache web server
2. The PHP application
3. The MySQL database
4. The database should remain consistent at all times in case of an error.

8
3.6.1 Reliability:
The reliability of the overall program depends on the reliability of the separate components.

3.6.2 Availability:
The system should be available at all times, meaning the user can access it using a web browser, only
restricted by the down time of the server on which the system runs. In case of a of a hardware failure
or database corruption, a replacement page will be shown. Also in case of a hardware failure or
database corruption, backups of the database should be retrieved with the MySQL server and saved by
the administrator.

3.6.3 Security:
1. Passwords will be saved encrypted in the database in order to ensure the user's privacy.
2. The user's IP will be logged.
3. The system will be protected against vulnerabilities such as SQL injection attacks.

3.6.4 Maintainability:
MySQL is used for maintaining the database and the Apache server takes care of the site. In case of a
failure, a re-initialization of the program is recommended.

3.6.5 Portability:
The application is Linux-based and should be compatible with other systems. Apache, PHP and MySQL
programs are practically independent of the OS-system which they communicate with. The end-user
part is fully portable and any system using any web browser should be able to use the features of the
application.

3.6 Other Requirements


Currently no other requirements are known. Should any other requirements occur during the software
implementation process or while running tests, they will be specified in an appendix

You might also like