Requirements Document

ECOACH - Reading Assessment

Lindsey Cook, Fall 2001
Lauren Ferguson, Fall 2001
Nolan Haisler, Fall 2001
Julian Russbach, Fall 2001
Libi Samuel, Fall 2001
Xiaofei Wen, Fall 2001
Christopher D. Wreh, II, Fall 2001

 


Table of Contents


Introduction

Dr. James Gregory and Dr. William Carter want to make the Reading Recall Time Efficiency Assessment Tool that they have developed available on the Internet. The mission of the tool is to allow people to self-assess their efficiency for learning through reading relative to other college students. Dr. Gregory and Dr. Carter's main goal is to make it easier for students to use the reading assessment tool. Their current system requires students to come to the Testing Center where the assessment is administered manually.

This team's objective is to design a web-based version of the reading assessment tool. The objectives for the assessment tool are to provide users a method to test for possible interference factors that reduce academic performance in college and to provide history or facts about Texas Tech University and other topics associated with the College of Engineering. The assessment will consist of two passages, with the flexibility for adding a third. The tool will time the user as he or she reads each passage and then ask the user a series of questions about each passage. The tool will calculate the time to read and reading recall for each passage and compare the results with those of other college students. The tool will then display the results for the student, using integrated information to make general recommendations and to provide tips to improve success in college. The passages, questions, and integrated information will all be stored in a database.

 


Special Terms/Abbreviations


Current Client System Diagram

<This diagram should show how the client is currently getting the job done.  It should show at a high level:  personnel, software, hardware, information flow, processes, and decision points, for the current system.  Standard Flow Chart or Data Flow Diagram Symbols should be used as much as possible.>


User Characteristics

Users

Types Of Users:

  1. College Students

  2. Junior College Students

  3. High School Students

  4. Professionals 

  5. Someone who suspects that they have a reading disability

  6. Someone who had a low preference for reading in the Learning Style assessment 

  7. Someone whose first language is not English

Skills:

  1. Basic reading ability

  2. Basic computer skills

  3. Ability to use a  mouse and keyboard

  4. Ability to use hyperlinks to navigate the Internet

User's Environment

<This section describes how the software product will be used at the user's site, such as where the software will run, when the software will be used, how the software will be used, and how backup and recovery operations will be done >


Requirements

External Interfaces

Functional Requirements 

2.  User Log on Interface and User Home page Interface:  The System shall have a Log on and Homepage user interface.  

Rank

Status

Rank

 1-Critical

2-In Development

 2-Moderate

2.1 Log On User interface

2.1.1 Main Screen: The system shall have a main screen.  The main screen should include the title- Reading Assessment, Guest Entry, Mission, Instruction, Information, Menu, Reading Assessment, Results and Recommendations, Tips on Reading, Evaluation of This Tool  (Please Help).        

2.1.2 Title:  The system shall have a tile name Reading Assessment.

2.1.3 Guest Entry: The system shall have a guest entry on the main screen

2.1.4 Mission: The system shall have a mission provide on the main screen. The mission shall be “the mission of this tool is to provide assessment of reading and feedback on appropriate action to improve academic success.”

2.1.5 Instruction:  The system shall have instruction on the main screen.

2.1.6 Information: The system shall have information on the main screen.

2.1.7 Menu: The system shall have interactive menu that include Reading Assessment Results and Recommendations, Tips on Reading, Evaluation of This Tool  (Please Help).

2.1.8 Reading Assessment:  The system shall have a reading assessment that is included under the menu on the main screen.

2.1.9 Results and Recommendations: The system shall have results and recommendations that are included under the menu on the main screen.

2.1.10 Tips on Reading: The system shall have tips on reading that is included under the menu on the main screen.

2.1.11 Evaluation of This Tool  (Please Help): The system shall have evaluation of this too (Please Help) that is included under the menu on the main screen.

2.2 User Home page Interface

2.2.1 Home page Screen: The system shall have a home page screen.  The home page screen should include the title- Reading Assessment, Guest Entry, Mission, Instruction, Information, Menu, Reading Assessment, Results and Recommendations, Tips on Reading, Evaluation of This Tool  (Please Help).        

2.2.2 Title:  The system shall have a tile name Reading Assessment on home page screen.

2.2.3 Guest Entry: The system shall have a guest entry on the home page screen. 

2.2.4 Mission: the system shall have a mission provide on the home page screen.  The mission shall be “the mission of this tool is to provide assessment of reading and feedback on appropriate action to improve academic success.”

2.2.5 Instruction:  The system shall have instruction on the home page screen.

2.2.6 Information: The system shall have information on the home page screen.

2.2.7 Menu: The system shall have interactive menu that include Reading Assessment Results and Recommendations, Tips on Reading, Evaluation of This Tool  (Please Help) on home page screen.

2.2.8 Reading Assessment:  The system shall have a reading assessment that is included under the menu on the home page screen.

2.2.9 Results and Recommendations: The system shall have results and recommendations that are included under the menu on the home page screen.

2.2.10 Tips on Reading: The system shall have tips on reading that is included under the menu on the home page screen.

2.2.11 Evaluation of This Tool  (Please Help): The system shall have evaluation of this too (Please Help) that is included under the menu on the home page screen.    

2.3  When the guest chooses Instruction option on the homepage of Reading Assessment, the system shall provide a link to a new page which shall introduce how to do reading assessment.

Rank Status Risk
2 - Needed 2 - In Development 3 - Straightforward

2.3.1  The client shall provide the whole INSTRUCTION web page to developer.

2.3.2  The system shall set up the link to the INSTRUCTION page provided by the client.

2.3.3  The INSTRUCTION page shall be opened in a different window from the READING ASSESSMENT window. The closing of this window shall be decided by the user.  The user can keep choosing all the other options on the READING ASSESSMENT homepage without closing the INSTRUCTION page.

2.4 System feature 4 “Questions”: There shall be a series of questions for each tester to answer after completing each timed reading section.

Rank

Status

Risk

1 (critical)

2 (in development)

3  (little difficulty)

2.4.1 Introduction/purpose of feature: These questions are designed to test each user’s comprehension and retention of information viewed in each reading selection.  The questions will be based directly on the material, and shall begin immediately after the tester has read the related selection.

2.4.3 Associated Functional Requirements:

2.4.3.1 There shall be two question answering sessions. One beginning after the first reading selection is viewed and completed. The other beginning after the second reading selection is view and completed.

2.4.3.2 Only one question shall be visible to the tester at a time.

2.4.3.3 The tester shall not be able to view previously answered questions, or questions to be prompted in the future. (i.e. the browser will not allow for navigation backwards or forwards through the questions)

2.4.3.4 After answering/completing a question the user shall be prompted to continue on.

2.4.3.4.1 When the tester has completed a question (selected an answer), a button will appear, prompting the user to continue. This button will either not be visible or not be accessible to the tester before the tester answers the current question.

2.4.3.4.2 When the tester has completed all the questions covering the first reading selection, the user will be prompted to continue to the second reading selection.

2.4.3.4.3 When the tester has completed all the questions covering the second reading selection, the tester will be prompted to continue to the “results page”.

2.4.3.5 There will be 10 questions for each reading selection

2.4.3.6 Each question will be a multiple choice and consist of a question and 4 possible answers labeled A, B, C, D, respectively.

2.4.3.7 All questions will be stored in the database.

2.4.3.8 The correct answers to the questions asked will be stored in the database.

2.4.3.9 The tester’s answers to each question shall be compared to the correct answer, and assessed as correct or incorrect.

2.4.3.10 The number of questions the user answers correctly per each reading selection shall be stored in the database, and associated with the current tester.

2.5 System feature 5 “Compilation”: The data collected from each tester’s test results shall be compiled into useful statistics reflecting the tester’s comprehension of the material and stored in a database.

Rank

Status

Risk

1 (critical)

2 (in development)

2  (moderate difficulty)

 

2.5.1 Introduction/purpose of feature:  The compilation of tester’s data collected from the test phases (timed reading assessment, and comprehensive questions) shall determine how each tester compares to the norm of test results.  A code will be generated for each tester with respect to their test results.  The codes shall be a number from 1 to 3 representing standard deviations from the mean of test results, where a code 3 represents that a tester’s score was 3 or more standard deviations from the mean score, a code 2 represents that a testers score was between 2 and 3 standard deviations from the mean score, and a code 1 represents that a testers score was 2 or less standard deviations from the mean.

2.5.3 Associated Functional Requirements:

2.5.3.1 Tester’s data shall be recorded in the database

2.5.3.1.1 The tester’s data shall be recorded in two sections: Reading Assessment A, Reading Assessment B.

2.5.3.1.2 The tester’s time taken for each reading selection shall be recorded in the database under its respective section.

2.5.3.1.3 The number of questions the tester answered correctly for each set of questions shall be recorded in the database under its respective section.

2.5.3.2 Each tester’s data shall be compared to the norm of the data.

2.5.3.2.1 The tester’s time for each reading assessment shall be compared to the norm and standard deviation of time of each reading selection. A statistical “z score” shall be calculated for the tester’s reading time.

2.5.3.2.2 The tester’s time for each reading assessment shall be compared to the norm and standard deviation of each reading selection. A statistical “z score” shall be calculated for the tester’s number of correct questions.

2.5.3.3 A code will be assigned to the tester based on the tester’s z score.

2.5.3.3.1 If the tester’s z score for a timed reading assessment is greater than 3 then a code of 3 will be assigned to the tester for that reading selection.

2.5.3.3.2 If the tester’s z score for a timed reading assessments is between 2 and 3, then a 2 will be assigned to the tester for that reading selection.

2.5.3.3.3 All other z scores for a reading selection will result in the assignment of a code of 1 to the tester for that reading selection

2.5.3.3.4 If the tester’s z score for a question section is less than -3, then a code of 3 will be assigned to the tester, for that question section.

2.5.3.3.5 If the tester’s z score for a question section is less than  -2 but greater than -3,  then a code of 2 will be assigned to the tester for that question section.

2.5.3.3.6 All other z scores for the tester will result in the assignment of code 1 to the tester for that question section. 

2.6 Timer and document

Rank

Status

Risk

 1

 2

 3

2.6.1 Feature purpose: After the user selects the assessment option, a timer will time how long it takes for the user to read a predetermined passage.

2.6.2 After the user selects the assessment option:

2.6.2.1 The client specified instructions for taking the test shall appear on a new screen.

2.6.2.2 A start button shall be centered below the instructions.

2.6.3 After the user selects the start button:

2.6.3.1 A new screen shall appear with the 1st client specified passage.

2.6.3.1.1 The passage title shall be black, 12pt Times New Roman Font and shall be centered above the passage.

2.6.3.1.2 The passage shall be black, 10pt Times New Roman Font, left justified, and paragraphed and spaced as in source file.

2.6.3.2 A timer shall begin when passage appears.

2.6.3.3 A stop button shall be centered below the passage.

2.6.4 After the user selects the stop button:

2.6.4.1 The passage shall be cleared from the screen.

2.6.4.2 The timer shall stop.

2.6.4.3 The user will not be able to return and view the passage before assessment is complete. The browser back button will be inactive.

2.6.4.4 The time lapse in seconds from the start of timer till the stop of timer shall be calculated and stored in a file.

2.7  The system shall provide the RESULTS AND RECOMMENDATION page, after the user finished the test.

Rank Status Risk
1 - Critical 3 - Not being worked on 2 - Moderate

2.7.1  The RESULTS AND RECOMMENDATION page shall display the "Time Score" of the user.

2.7.1.1  The time score is the user's reading time.

2.7.1.2  The time score shall be used by the system to calculate the "Efficiency for Time Use". The formula below shall be displayed on the page.

2.7.2  The RESULTS AND RECOMMENDATION page shall display the "Recall Score %" of the user.

2.7.2.1  The recall score % = Number right / 0.1

2.7.2.2  The recall score % shall be used by the system to calculate the "Efficiency for Reading Recall". The formula below shall be displayed on the page.

Efficiency for Reading Recall = Individual Reading Recall / Average Reading Recall for college student    

(If efficiency exceeds 1, then set to 1.)

2.7.3 The system should display a nice message of recommendation to the user according the Efficiency for Time use and Efficiency for Reading Recall.

2.7.3.1  The messages for the recommendations shall be provided by the client.

2.7.3.2  The system shall provide two kind of recommendations. One is that the individual should seek professional assessment. The other is that the individual does not need to seek professional assessment.

2.7.3.3  The system shall provide how the recommendation is made. The following information shall be displayed.

If Efficiency for Time Use is less than or equal to 0.5 then recommend the individual seek professional assessment.

If Efficiency for reading Recall is less than or equal to 0.5 then recommend that individual seek professional assessment.

2.7.4  The system shall create a PRINT button to ask user if he/she need to print out the results and recommendation page. If the "PRINT" option is chose,  the printer which connected to the computer shill print out the RESULTS AND RECOMMENDATION page.

2.7.5  The system shall provide two way to access the RESULTS AND RECOMMENDATION page.

2.7.5.1  After the user finishes all the tests, this page shall automatically show up.

2.7.5.2  After the user finishes all tests, and before the user closes the window, the user shall be able to access the results and recommendations anytime by clicking the "Results and Recommendation" button on the reading assessment homepage. 

2.8 Reading tips

Rank

Status

Risk

 2

 2

 3

2.8.1 Feature purpose: When the user selects the “Tips on Reading” option from the home page, a new page appears with a tips document.

2.8.2 After the user selects the “Tips on Reading” option from the home page:

2.8.2.1 A new page shall appear with a client formatted and specified document.

2.8.2.2 A return button shall be centered below the tips document.

2.8.3 After the user selects the return button:

2.8.3.1 The home page shall be displayed.

 

Performance Requirements

Logical Database Requirements

Design Constraints

Software System Attributes

Other Requirements

 


Use Case Model

Use Case Diagram

<This section shows the use case diagram with the system delineated by a bounded box, with all of the actors, and with all of the use cases.>

Use Cases

<Use Cases in this section should show how the user would interact with the system.   Each should be given a unique ID for cross-referencing purposes and named with the actor of the use case, the use case's action, and the subject of the use case.  The sections are as follows:

All MAJOR user interactions should be given as use cases which means that use cases with one to three user actions in the scenario are probably too trivial to include.>

<ID> Use Case <ActorActionSubject Name>

Overview

Preconditions

Scenario

User Action System Reaction
Action 1 Reaction 1 to Action 1
Action 2 Reaction 2 to Action 2
Action 3 Reaction 3 to Action 3
Action 4 Reaction 4 to Action 4
Action 5 Reaction 5 to Action 5

Scenario Notes

Post Conditions

Exceptions

Problem Domain Model

<This diagram should show how the client would like the system to work.  It should show at a high level the interface, entity, and control objects for the system.  Subsystems should be appropriately partitioned.>


Client Materials

<The client may provide the team with additional materials for use in developing the project.  At a minimum, these should be noted here and how to obtain them (linked if possible with the client's permission).>


Reference Materials

<Additional reference materials may be needed to help with understanding and developing the project.  In addition, you may have used some reference materials to write the requirements document and cited them in the text.  These should be listed here in an organized and appropriate bibliographic format.>


To Do List

Items
Add diagram for Current User System
Fill out Use Case Section
Link table of contents

Team Request Forms

<List of issues/questions needing to be resolved  by other team members.  Should be organized by receiving team member and within that by reverse chronological order.>


Revision History

Date Name Revision
11/07/2001 Lindsey Cook Created Document
11/08/2001 Lindsey Cook Edited User Characteristics, formatted Functional Requirements, Added 2.6 and 2.8 sections of the Functional Requirements