Software Requirements Specification for Peer Tutoring Record Keeping

Transcription

1 1 Software Requirements Specification For Peer Tutoring Record Keeping Version 1.0 approved Prepared by Robert Jarvis, Mario Lopez and Edward Martinez CPSC 430 Group 4 September

2 2 Table of Contents Table of Contents Revision History 1. Introduction 1.1 Purpose 1.2 Document Conventions 1.3 Intended Audience and Reading Suggestions 1.4 Product Scope 1.5 References 2. Overall Description 2.1 Product Perspective 2.2 Product Functions 2.3 User Classes and Characteristics 2.4 Operating Environment 2.5 Design and Implementation Constraints 2.6 User Documentation 2.7 Assumptions and Dependencies 3. External Interface Requirements 3.1 User Interfaces 3.2 Hardware Interfaces 3.3 Software Interfaces 3.4 Communications Interfaces 4. System Features 4.1 Accounts 4.2 Analytics 4.3 Input Data 4.4 Database 4.5 Final Print 4.6 User Interface 5. Other Nonfunctional Requirements 5.1 Performance Requirements 5.2 Safety Requirements 5.3 Security Requirements 5.4 Software Quality Attributes 5.5 Business Rules 6. Other Requirements Appendix A: Glossary Appendix B: Analysis Models Appendix C: To Be Determined List Revision History

3 3 Name Date Reason For Changes Version 1. Introduction 1.1 Purpose The purpose of this software is to provide an efficient alternative for recording attendance and grades for students participating in the Peer Assisted Study Session (referred to as PASS) program. The Software will also give mentors, professors and the administrators separate user accounts, which will allow them to post information such as grades and attendance for their respective students in PASS. The software will also analyze the data inputted and provide statistical information about the students in PASS. The only students recorded in the system will be students who sign a consent form, no student data will be taken if they have not signed a consent form. 1.2 Document Conventions The only convention followed while writing this document was the template obtained from the Institute of Electrical and Electronic Engineers (IEEE). Each requirement will have its own priority, as the client has asked for specific features to be completed. 1.3 Intended Audience and Reading Suggestions The readers of this document will be the client, project supervisor, and software engineers. The remaining contents of this requirements document will give an overview of what features the software will satisfy, how the software will complete those goals, and any interfaces the software will require. 1.4 Product Scope The software being developed will meet the time, grade, and attendance keeping needs of PASS. The software will function across different platforms to enable the students and mentors to keep track of times reliably and effectively. The system will also provide professors with the ability to input the student grades at the end of the semester and indicate whether or not the student s academic performance is satisfactory. The ultimate goal of the software is to generate a correlation test to see if attending the PASS program actually had a positive affect on student performance. The results shall be outputted to the two administrators of the program. 1.5 References

4 4 PASS Information Sheet Dr. Venitta McCall Trinkle Overall Description 2.1 Product Perspective This product is self contained.. The product will be a web based system that will allow user access. The type of user access and interface as well as roles and abilities will be dependant on the type of user. This access will be part of smaller systems dependant upon roles played in the software. They will be all connected independently and directly to the main system for data upload which will limit complexity of interconnection as well as provide greater reliability between the smaller systems and the main system which will provide the storage and necessary capabilities. 2.2 Product Functions Allow mentors/professors and administrators to log in Allow professors to input grades of the students Allow professors to view the attendance of their respective students Allow administrators to create/remove mentors, professors and students Allow administrators to specify which students have given consent Allow administrators to view all student data Allow mentors to input attendance information about students The software will be able to provide statistical information about the PASS program 2.3 User Classes and Characteristics There will be three different user classes accessing the software: Administrator, Mentor, and Professor. Each user level will give different privileges depending on which user is logging in. The administrator will have access to all features of the software. They will be able to make any adjustments and corrections to the data in the software. The mentor will be able to create mentoring sessions within the system, and record and edit attendance records. The mentor will not be able to view student grades. The professor will be able to input final grades for the class and view attendance records. 2.4 Operating Environment The software will be web based, allowing most computers with web browsers to access the software. The data of the software will exist in a database housed within servers that the administrators will have access to. 2.5 Design and Implementation Constraints Issues that might arise that might limit the options available to developers is the need to be web based and

5 5 the compatibility issues that might arise in having to operate on different platforms, operating systems and web browsers. Other issues might be in the communication protocols between these platforms and the security risks posed in the transmission over different networks and in having different users with different abilities with access to different information. Being web based, designing as well as updates and fixing bugs in the system will be relatively easy since the software doesn t have to be downloaded on every machine however there are compatibility concerns with each given machine attempting to access the software. 2.6 User Documentation The software will include a read me manual explaining the features each user will be able to access. Each feature will come with step by step instructions. The step by step tutorial will include screenshots for logging in, and using features. This tutorial will provide a simple yet effective way to learn the software. All source code will be heavily documented, ensuring that it will be able to be reused by developers in the future. Depending on the language used, a document will be exported detailing each class and variable to give more ease to future developers. 2.7 Assumptions and Dependencies Most web browsers will be able to support the software The client will supply the servers and will be responsible for maintaining them The software will be able to operate on most operating systems that have access to online capabilities The software and database will exist on a server and can be accessed through online interactions 3. External Interface Requirements 3.1 User Interfaces All users will go through a log in page to access the software. The log in page will include text fields where the user can input his or her user name and password and an enter button to submit the information. Correct credentials will lead to the home page and any wrong credentials will display an error message stating incorrect credentials. The home page will have certain fields, which are dependant on the user s account such as certain input fields and display buttons. Input fields will allow the users to input information regarding their respective students from a list into the database. Display buttons will allows users with appropriate accounts to view information about their respective students. 3.2 Hardware Interfaces The characteristics of each interface will be the compatibility between the browser used to access the web based software. Because the product is web based, the intention is for the product to be supported by hardware systems that are compatible with the most widely used operating systems and web browsers on the current market such as Windows and Mac OS. Making it responsive to tablets and smart phones

6 6 would be an important logical characteristic. The primary interaction between the software and hardware would be the interaction between the software and servers. The servers would run continuously to allow reliable data entry at all times. 3.3 Software Interfaces The software will be web based so it will need to be able to interact with all Internet browsers. The software should not be complex so that the user will need to download a different program just to run the software. The software will be communicating with databases via the network and will need to be able to push and pull data with the server. 3.4 Communications Interfaces The communication function is key to the functionality of the software. Compatibility with multiple web browsers is important to incorporating device and platform usage. A secure HTTP connection would be primary form of data transmission especially in the transmission of sensitive data such as student grades and attendance. The network server communications protocols must ensure security but also allow different users to communicate reliably with the server using different devices and web browsers. 4. System Features 4.1 Accounts Description and Priority The software will support three different user accounts. The Administrator account will have access to all data in the database and all features. Professor and Mentor accounts will have limited access to the database, as they can only interact with data of their respective students. The Administrator will be able to create new Administrator, Professor and Mentor accounts and can also remove them from the database as well. MED HIGH Stimulus/Response Sequences The user will go on to the log in page of the software and input their user name and password. Correct account information will lead to a home page and incorrect information will display error messages in this order of priority. Incorrect user name log in information An error message will appear stating that the user name is either misspelled or does not exist Incorrect password log in information An error message will appear stating that the user name or password is incorrect

7 7 Once logged in, the users will be able to perform their abilities restricted to their accounts Administrators: Create/remove accounts View and adjust student data View statistics on data Professors: View their student s attendance Input grades for their students Mentors: Input attendance for students When the users are done they can log off by clicking a log off button Functional Requirements 4.2 Analytics REQ 1 1: The software shall be able to create and store separate accounts REQ 1 2: The accounts shall be able to have unique user names and passwords REQ 1 3: The software shall allow users to sign in to their accounts through the use of their passwords and user names REQ 1 4: The software must display error messages when incorrect account information is inputted REQ 1 5: The software shall the users to log off their accounts REQ 1 6: The software shall allow data to be inputted for students REQ 1 7: The software shall be able to know which accounts have access to specific students REQ 1 8: The software must be able to analyze the data in the database Description and Priority The software shall analyze the data in the database and output the information in some way such as a bar graph, a pie chart or some other form of displaying the data. The analysis of the data should be mostly concentrated on the correlation between attendance of PASS and grades received in the class that the sessions were intended for. Only the Administrators of the software will be able to view the analysis of the data from the database directly. HIGH Stimulus/Response Sequences

8 8 The Administrator, once logged in to the software, will be able to view an analysis of the data in the database by clicking an analyze button. Once clicked, the software will begin gathering data and sorting it by attendance and calculating the grades received by the students. An example of the how the analysis should be based on below: Students who attended an average of 5 sessions in Biology, received an average grade of B+ Students who attended sessions tended to receive an average boost of 1.5 points to their final grades for each session attended Students who did not attend PASS, received an average of half a letter grade lower than those students who attended did in Math related courses Functional Requirements 4.3 Input Data REQ 2 1: The software must be able to maintain a database REQ 2 2: The software must be able to receive and input data into the database REQ 2 3: The software must have some sort of algorithm that will be used to analyze the data in the database Description and Priority The software will enable users to input data about their students in PASS. Each user has an account which allows them to input specific data about their respective students. The Mentor accounts will input attendance information for students that are in their sessions. The Professor accounts will input grades for students in their classes and the Administrator accounts will be able to input both attendance information and grades for the students if needed. HIGH Stimulus/Response Sequences Administrator accounts: Once logged in, the Administrator will be able to adjust student data through the use of input buttons and a display button Professor Accounts: Once logged in, the Professor will be able to input grades of his/her students through the use of an input button Mentor Accounts: Once logged in, the Mentor will be able to input attendance information for his/her students

9 9 Inputting Grades: Grades will be inputted for each individual student using a drop down box which will list all possible grades, and will be submitted when the enter button is pressed on the screen Inputting Attendance: Attendance will be inputted for a list of students by first selecting a date from a drop down box and then checking off on which students attended Functional Requirements 4.4 Database REQ 3 1: The software must be able to utilize the database REQ 3 2: The software must be able to insert data into the database REQ 3 3: The software must be able to know which accounts have access to specific students Description and Priority The software shall maintain a database to store all the data that will be inputted by the Mentors, Professors and Administrators such as: Student s first name and last name Class attending the sessions for Attendance Grades HIGH Stimulus/Response Sequences TBD The group that will implement the software will decide upon the specifics of the database Functional Requirements 4.5 Final Print REQ 4 1: The software must be able to receive data through the use of forms REQ 4 2: The software must be able to have a way to insert the data REQ 4 3: The software must have an independent server in for the database to exist in Description and Priority

10 10 The software, at the end of the semester, will be able to analyze all the data that has been gathered for that semester and print it out to the screen to be used in further analyses by the Administrator. This Final print out differs from the Analytics feature as it is a much more simpler description of the data and is intended to give the Administrator a quick and simple view into the data of PASS. Graphical representations of the data should be considered to be printed out as well. A basic example of the data that should be outputted onto the screen: 43% of students attended more than 4 sessions 30% of students involved in PASS received an A for a final grade 68% of students in Biology sessions received grades higher than a B LOW Stimulus/Response Sequences The Administrator, once logged in, will be able to click a button on the home page of the software that will output the data into the screen. The data will be displayed into different categories such one based on attendance, another based on grades and more. If it is not the end of the semester or near the end, this option will not appear for the Administrator to select Functional Requirements 4.6 User Interface REQ 5 1: The software shall be able to analyze the data in the database REQ 5 2: The software shall know when the end of the semester is near in order to have the feature available REQ 5 3: The software should have a visual representation of the data Description and Priority The software interface should be simple and easy to use. The interface of the software should be clutter free and contain only the fields necessary to interact with the database. The web pages of the software should also be have titles indicated what the page is such as the log in page having the words Log in at the top of the screen. LOW Stimulus/Response Sequences TBD The group implementing the project and the client will decide the specifics of the interface,

11 11 as the client should be the one who ultimately decides whether the software is simple to use Functional Requirements There are no requirements for this feature as this is a design problem and is not affected by any other system feature 5. Other Nonfunctional Requirements 5.1 Performance Requirements There are no major performance requirements for this software other than it must perform the features listed in System Features. 5.2 Safety Requirements There are no safety requirements for this software. 5.3 Security Requirements The software must allow users to choose their own passwords in order to ensure those with the correct credentials only view the data. Only the Administrators can view the data in the database and it is up to his/her discretion on who can see the data and what can be done with the data. The software must also have a way to indicate whether a student has given consent for the study, as this will indicate whether his/her name will appear in the statistical printout. 5.4 Software Quality Attributes The software must be able to have access to the most updated version of the database at all times. The software must be able to support multiple versions of it running at the same time on multiple computers and must still be able to maintain an accurate database. The software must also be reusable throughout the years, by having the ability to remove and add students as the PASS program progresses through the semesters. 5.5 Business Rules Only the client can initially decide who will be Administrators, Professors and Mentors in the software. 6. Other Requirements Appendix A: Glossary

12 12 PASS Peer Assisted Study Session Appendix B: Analysis Models Appendix C: To Be Determined List 1. Database Design 2. User Interface Design