This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Software Requirements
Specification
For
IAP Evaluation Portal
Prepared by:
Abhinav Garg (101303004)
Akshit Arora (101303012)
Arush Nagpal (101303034)
Chahak Gupta (101303041)
Thapar Institute of Engineering and Technology University, Patiala
25th February, 2016
Software Requirements Specification for IAP Evaluation Portal Page ii
Table of Contents
Table of Contents .......................................................................................................................... ii
Revision History ............................................................................................................................ ii
2. Overall Description ..................................................................................................................4 2.1 Product Perspective ......................................................................................................................... 4 2.2 Product Features .............................................................................................................................. 4 2.3 User Classes and Characteristics ..................................................................................................... 6 2.4 Operating Environment .................................................................................................................... 6 2.5 Design and Implementation Constraints .......................................................................................... 6 2.6 User Documentation ........................................................................................................................ 7 2.7 Assumptions and Dependencies ...................................................................................................... 7
3. System Features ........................................................................................................................7 3.1 Student, Faculty and Industry Mentor Registration ......................................................................... 7 3.2 Student, Faculty and Industry Mentor Login ................................................................................... 8 3.3 Student Assessment Upload ............................................................................................................ 9
midway report and final report) and edit password.
REQ-2: For faculty, the tasks they can do with their dashboard are: upload
assessment of every student assigned to them, edit personal details and set
city preferences.
REQ-3: For industry mentor, the tasks they can do with their dashboard: upload
assessment details of every student working under them.
REQ-4: After any major change is made by student, industry or faculty a
notification is generated for relevant users.
3.3 Student Assessment Upload
3.1.1 Description and Priority
This feature is required to compute the final assessment of student from industry
mentor and faculty.
3.1.2 Stimulus/Response Sequences
Stimulus: The reports and company details are submitted by student
Response: Faculty / Industry mentors submit the evaluation details.
2.1.3 Functional Requirements
REQ-1: For faculty, the evaluation form needs to be submitted. And example report
has been mentioned in Appendix 1 at the end of the report.
REQ-2: For industry mentor, the evaluation form needs to be submitted. And
example report has been mentioned in Appendix 2 at the end of the report.
REQ-3: When final student evaluation forms have been submitted by both faculty
and industry mentor, admin is notified and student's final evaluation can be
locked and approved.
Software Requirements Specification for IAP Evaluation Portal Page 10
4. External Interface Requirements
4.1 User Interfaces
The interface provides a variety of options to the users. It allows the following features:
Student Interface: It opens up after student logs in from General Audience Interface. It will contain
the following major panels:
Login Page: Meant for opening up administrator, faculty, mentor and student interface
Training details: options for editing the details of the training undertaken by the student.
Documents: options for uploading the joining report, emergency details, goals report
Publications: options for addition / deletion of research publication records.
Profile: options editing the profile page of the student.
Settings: Access to various student settings
Administrator interface: It opens up after administrator logs in from General Audience
Interface
Student records: Access to student information.
Faculty Records: access to faculty information.
Mentor panel: evaluating students performance and providing feedback for the same
Settings: Administrator settings manipulation.
4.2 Hardware Interfaces
IAP portal is a website that can be accessed from any device be it a computer desktop, laptop,
tablets, phones or any other device having a NIC (Network Interface Card).
4.3 Software Interfaces
As mentioned earlier the project is a website hence can be accessed from any device. It does not
require any particular operating system to execute. All it needs is just a modern web browser (like
Safari, Firefox, and Google Chrome etc.)
Software Requirements Specification for IAP Evaluation Portal Page 11
4.4 Communications Interfaces
The students are required to send request through email to the administrators for editing their
training details. Mentors and faculty members can send email to each other to discuss about students
performance.
5. Other Nonfunctional Requirements
5.1 Performance Requirements
• Reliability: Auxiliary storage devices must be available for backing up the data. The internet
connection in the school must be stable most of the time.
• User Interface and Human Factors: The training for using the admin panel is required to be
provided so as to prevent him/her from making errors.
• Availability: The website shall be available, up and running for 24*7 throughout the year
except due to the routine maintenance activities.
5.2 Safety Requirements
There are no specific safety requirements associated with the proposed system. The portal executes
on well-known and commonly used hardware which does not cause any safety hazards.
5.3 Security Requirements
Security is one of the points of concern in this system.
• A validation link will be send to the registered users.
• The password details that are stored in the database should be in encrypted format so that the
data cannot be read directly.
• Only a registered user should be able to access the account and perform various tasks such as
updating the training details, editing user profiles etc.
• PHP functions should be used to prevent the users from entering malicious queries into the
database.
Software Requirements Specification for IAP Evaluation Portal Page 12
• Various security attacks like CSRF, session forgery and cross server scripting attacks will be
prevented using secure PHP coding practices.
5.4 Software Quality Attributes
Reliability
The portal should provide reliability to the user that the website will run stably with all the features
mentioned above available and executing perfectly. The server on which the website will be
deployed must be able to handle large number of hits on the website.
Resources
Thapar Connect should be designed in such a way that the query of the user can be fulfilled with
minimum number of accesses to the database thus improving speed.
6. Technological Requirements
The project makes use of the following technologies:
Apache: It acts as the local server for testing of website during the development phase.
HTML/CSS/JavaScript: These languages will be used to develop the front end i.e. The UI of the
website. AJAX might also be used to improve the user experience while browsing the site.
PHP: It will act as the language for server side scripting. All the interactions with the server will be
done using the code written in PHP.
Database: RDBMS will be used in the system. PHP MySQL connectivity functions will be used to
link the database to the website.
Frameworks:
PHP frameworks like CodeIgniter will be used for faster and modular web development.
JavaScript Libraries like Typeahead.js, tablesorter.js, jquery.js, printit.js will be used for modularity
and ease of accessibility.
HTML and CSS frameworks like Bootstrap will be used for responsive view of the website.
Software Requirements Specification for IAP Evaluation Portal Page 13
7. APPENDICES
Following are some resources gathered by the time at the time of requirement analysis from the client. APPENDIX – 1 Faculty and industry evaluation rubrics and form.
Software Requirements Specification for IAP Evaluation Portal Page 14
APPENDIX – 2 Industry mentor evaluation form.
Software Requirements Specification for IAP Evaluation Portal Page 15
APPENDIX – 3 Student Emergency Contact form and Joining Report.