Design

ECOACH - Reading Assessment

Keith Andrew Brumbaugh, Spring 2002

Ayotunde Phillips, Spring 2002

Jeremy Levi Stanley, Spring 2002

Jennifer Perez , Fall 2001

Michael Peterson, Fall 2001

Melyssa Boswell, Fall 2001

Mukundan Desikan, Fall 2001

Jianjun Zheng, Fall 2001

Rajesh Subedi, Fall 2001

Brent Job, Fall 2001

Table of Contents

• Design Approach
• Similar and Supporting Work
• System Architecture and Deployment
• User Interaction
• Data Storage/Format
• External System Interfaces
• Detailed Design
• Implementation Platform
• Reference Materials
• To Do List
• Requirements Issues List
• Team Request Form
• Cross-Reference Table

Design Approach

Due to the nature of this project and the design document, we have been using the event-oriented decomposition and outside-in design methodologies. These design methods seem to fit the project best, based on the client’s and programmer’s needs and the requirements document.  Due to the lack of a conceptual design needed for the client, the design document is to be primarily utilized by the programming team, this also eliminates the need for modular decomposition, since no low level explanations of organization are needed.  The event-oriented decomposition fits well in this situation because the page formats have been well defined by the client so the main design task is to spell out how certain events change the state of these pages.  This also allows work to be started on the general (high level) states while requirements gathers information needed for a more detailed design. Outside-in design is similar to event-oriented decomposition in that it allows the design team to work with the inputs and outputs to the system without immediately considering the specifics of what the system does with this data. This will allow the user to make different inputs while the software decides how to rank the users inputs. Object-oriented design is not used because the Outside-in design is more suited for this software. Data-oriented decomposition is not used since user events are not supposed to change the working of the program, it should continue to function normally.

Similar and Supporting Work

This document has been produced using supporting work from the class website (http://sework.cs.ttu.edu/proj/design_template.htm).   This provided an outline on GUI interface design as well as various other tips. 

Some similar programs to this one are “Ace Reader” and “Mindplay.”

Ace reader is a “Productivity and Self-Improvement Educational reading tool.” Its significance to this project is that it has a diagnostic reading assessment tool included in the software. This lets the user see their current reading level. The product is available with various versions from $24.95-$566.00

Mindplay is another reading diagnostic tool. It has a phonics test and a reading comprehension test. Their reading test runs differently from our Reading Assessment program in that rather then having the user read a large paragraph the fill in answers, it gives the user a small paragraph and asks the user to choose words that best fit within the sentences. Similar to our Reading Assessment program, the program takes your answers, and your time, then calculates your grade. Mindplay offers a free test and is recommended for grades 2-10.

Resources

http://www.mindplay.com/

http://www.test4free.com/

http://www.acereader.com/

System Architecture and Deployment

User Interaction

2.1 Relationship Diagram

Every shaded box represents a web page and every other box represents a link except the mission and menu box. Diamonds represent composition,  Straight lines represent association, Straight lines with arrows represent navigation, and Dotted lines with arrows represent dependency. 

2.2 Display Screen Formats, Menus, and Fault Handling

2.2.1 Main Screen

The Main Screen shall look as shown in the following diagram: 

Display

Display Components

• This page shall include the following links: Guest Login, Instructions, Information, Abandon Session, Reading Assessment, Results and Recommendations, Tips on Reading, and Evaluation of This Tool.

2.2.2 Guest Entry Screen

The Guest Entry Screen shall look as shown in the following diagram: 

Display

Display Components

• This link shall lead to a page, which will prompt the user for his/her personal information.  If the user leaves the answer as "Yes", the last two questions will not appear.  If the user selects "No" as the answer to the "Is English your first language?" question, then the last two questions will appear.  Once the user has entered their valid information, the user will then be able to begin the reading assessment test.

 Error Handling

• Error: User tries to continue without completing screen.  

          Error handling: User is shown a message box stating that they must complete the     

                 information before continuing.

2.2.3 Information Screen

The Information Screen shall look as shown in the following diagram:

Display

Display Components

• This link shall lead to a page that provides the user with information over the reading assessment tests.

2.2.4 Instructions Screen

The Instructions Screen shall look as shown in the following diagram:

Display

Display Components

• This link shall lead to a page, which will introduce how to do the reading assessment before the user begins the reading assessment tests. Once the user has read the instructions, they may then begin the reading assessment test.

2.2.5 Reading Passage Screen

The Reading Passage Screen shall look as shown in the following diagram:

Display

Display components

• This screen shall have a start button. Upon clicking the start button the passage and stop button shall appear.
• This page shall contain a link to the data base where each passage is stored.

2.2.6 Questions Screen

The Questions Screen shall look as shown in the following diagram:

Display

Display Components

This page shall have one question. The answer shall be stored as a variable and use in the calculations of 2.3 .

Error Handling

If the User tries to proceed without answering the question a message box will appear stating that the user must answer to proceed.

2.2.7 Results and Recommendations Screen

The Results and Recommendations Screen shall look as shown in the following diagram:

Display

Display Components

• This link shall only be accessed after the reading assessment tests have been completed. It shall then display the users results and recommendations.

2.2.8 Tips On Reading Screen

The Tips on Reading Screen shall look like the following diagram:

Display

Display Components

• This link shall display a list of helpful tips that the user might need before beginning the assessment test. This shall be accessible either before the test begins or after the test is completed.

2.2.9 Evaluation Screen

The Evaluation Screen shall look like the following diagram:

Display

Display Components

• This link shall lead to a page, which will give the user an opportunity to evaluate the reading assessment tests once the user has completed the test.

2.2.10 Error Screen

Display

Display components

• This page shall be brought up if the user licks on any link in the system without being logged in. The first here links to the main page and the second here links to the Guest Login page. 

2.3  Report Formats

2.3.1 Results

Report Display

Results and Recommendation 

·   Time Score =         251                                    ·  Recall Score % = Number Right

                        Reading Time                                                                       0.1

·  Efficiency for Time Use =              Individual Time Score              

                                            Average Time Score for college students

·  Efficiency for Reading Recall =              Individual Reading Score              

                                                   Average Reading Score for college students

·        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.

Your Time Score:  (display Individual Time Score here)

Your Recall Score %:  (display Individual Recall Score here)

(message of recommendation to the user according to the Efficiency for Time Use or the Efficiency for Reading Recall should come up here.  wording is provided by client) 

PRINT

Report Components  

• Screen Title
• Efficiency for Time Use
  • Individual Time Score = 251 / Reading Time
  • Efficiency = Individual Time Score / Average Time Score for college students
  • If Efficiency > 1, set Efficiency = 1.
  • If Efficiency <= 0.5, recommend professional assessment
  • Output: Individual Time Score
• Efficiency for Reading Recall

  o        Individual Recall Score = Number Right / 0.1

  o        Efficiency = Individual Recall Score / Average Recall Score for college students

  o        If Efficiency > 1, set Efficiency = 1.

  o        If Efficiency <= 0.5, recommend professional assessment

  ○     Output:  Individual Reading Recall Score

• Recommendation
  • Output:  Appropriate recommendation (wording by client)

• PRINT button

2.4 Human Interfaces

• (2.4.1) The user shall use a monitor (as an output device) to read the choices and to know what he/she has to choose from. 
• (2.4.2) The user shall also use a mouse (as an input device) to click on various choices on the "guest entry" screen. 
• (2.4.3) If the user does not have access to a mouse, he/she could use a keyboard to "tab" to the various selections and use the spacebar or arrow keys to select the desired choice. The system shall have error handling in case the user attempts an action that should not be done. The user will not need to type any text. However, the user will need to use drop-down boxes, option buttons, and command buttons.

Data Storage/Format

3.1 Data Structures

N/A

3.2 Files

3.2.1 Two Files:

    3.2.1.1  the filenames shall be in the form *.htmf

                 example:    BACCII.htmf

                                   TexasTech.htmf

    3.2.1.2  each file will be listed in the database under the filename column of    the passages table

    3.2.1.3  each file will contain a passage and the passage will be an html fragment. (the fragment is the html between the body element on a normal html page

3.3 Databases

3.3.1

3.3.2

3.4 Additional Information

3.4.1  Passage Title:

    3.4.1.1  Black

    3.4.1.2  12 point Times New Roman

    3.4.1.3  Left Justified

3.4.2  Passage:

    3.4.2.1  Black

    3.4.2.2  10 point Times New Roman

    3.4.2.3  Left Justified

    3.4.2.4  Paragraphed and Spaced as in Source File

External System Interfaces

The external systems designed for the software system shall include Internet Information Server (IIS) ASP.dll, global.asa, SQL server, ADO objects, VB script, and FrontPage and Internet explorer 4.0.

4.1  Internet Information Server (IIS)

IIS version 4.0/5.0 and can be run on Windows 95,Windows98, Windows NT, Windows2000 and comes with ASP 2.0 as standard.

This software/interface loads all the associated files needed for storing and executing the ASP page.

4.2  ASP.dll description

When a client (browser) requests an ASP page from the web server, the server passes the request to ASP.dll, which first checks whether global.asa is executed.

ASP.dll executes global.asa if it is not executed.

When the user requests the questions page, a request is in turn passed on to ASP.dll which processes the request

This file is stored in the directory C:\windows\system\inetserv

If you can not see it, make sure you have turned the show hidden files option in windows explorer.

The file global.asa is a text file that contains details about an ASP application, such as when it should begin and end. Each application has only one global.asa and is placed in the virtual directory root.

The two main components of this file are Application and Sessions. An application starts when the first user accesses a web page in the system. A session starts when any user accesses a web page in the system.

This file shall consist of four main functions namely Application_onstart, Application_onend, Session_onstart, and Session_onend. It needs to contain the commands to open connection and access the data store in the SQL server.

4.3.1 Sample of global.asa

<Script language = "vbscript" RUNAT = "server">

Sub application_onstart

Vbscript goes here…

End sub

Sub application_onstart

Vbscript goes here…

End sub

Sub session_onstart

Vbscript goes here…

End sub

Sub session_onend

Vbscript goes here…

End sub

</script>

Connection to the database server shall have to be established in order to store data entered by the users and to retrieve information from the data store to the users.

The database shall contain the links to passages and the questions for the users.

Establishing a connection to the database shall have to be done using the command

Dim objconn

Set objconn=server. Create object ("ADODB.connection")

The database connection may be opened by sending the system dsn filename located on the computer on which the software runs, database username, and database password.

Call objconn ("dsn name","username","password")

Open the connection with the command

Objconn.open ()

When there are no more users, close the database connection

Objconn.close ()

The ADO object enables interaction with database-stored procedures. It is used for running processes against a data store.

This helps to load the passages and questions from the data store and present to the user for viewing and analyzing it.

It helps to insert questions for the passages and retrieve it to the users.

These can be commands that return record sets or they could be commands that do not return any values. It is used to update the records in the dataset.

Set objcommand =server. Create object ("ADODB.command")

Objcommand.execute

These commands can be used to access the records in the database. We can modify or display all the records of a data store.

Set object =server. Create object ("ADODB.Recordset")

ObjRec.execute

ObjRec.open"SELECT " * from table name

4.6  VB Script

This language helps to present user interactive pages and shall have to be declared as the first command while writing the ASP codes.

This script used in the ASP file helps to design the home page, guest entry forms, question pages and the result page

4.6.1 Script language

<Html><head>

<Title>an example</title>

</head>

<Body bgcolor=blue>

<P>today’s date is

<Script language =Vbscript>

Document. Write (Date)

</script></body>

</html>

Front Page, 98/2000 helps to modify/create the web pages and presents it effectively to the users. This Interface helps to modify the guest entry page, logon page, home page and can make us preview the web page before presenting it to the users.

IE 4.0 shall have to be installed in order to visualize the working of the software. The users need this to use the software to evaluate their performance, and get the results.

Detailed Design

5.1 Main Page

5.1.1 Guest Login Page

5.1.2 Passage Page

5.1.3 Tips on Reading Page

5.1.4 Instructions Page 

5.1.5 Information Page

5.1.6 Reading Results Page

5.1.7 Evaluation Page

5.1.8 Calculations Page

There shall be the following calculations:

·        Amount of time spent on reading the passage

·        Questions answered correctly “z score”

·        The standard deviation of time for reading the passage

·        Average reading time for college students

·        Average number of correct answers for college students

·        Typical standard deviation of correct answers for college students

5.2 Use Cases

Overview

The main page’s function is to allow the user to reach all areas of the Reading Assessment site. The main page displays the Mission Statement along with links to: Guest Logon, Instruction, Information, Reading Assessment, Results and Recommendations, Reading Tips, and Evaluation of this Tool.

None

1. 1, 2, 3 and 6 can be selected at any time.
2. 4 may only be selected after the Guest is logged on.
3. 5 and 7 may only be selected after the Guest has taken the Reading Assessment.

User is taken to the desired site

None

User is logged out of the system but the options for 4, 5 and 7 are still selectable. They system shall take the user to the error page.

None

After X minutes of inactivity, log the user off of the server.

Overview

The Guest Entry page’s function is to log the guest onto the server and grant the user access to the Reading Assessment test.

None

Scenario Notes

1. 1, 2 can be answered at any time.
2. If “yes” is selected on 2, a pop up should appear stating “The Survey is complete. Click “Submit” to continue.”
3. 5 Proceeds when 1 and 2 are filled out if “yes” is selected in 2. If “no” is selected, 3 and 4 must be filled out too.

After a successful “Submit,” user is logged on and taken back to the main page. The Main Page link to “Reading Assessment” is made available.

None

If user clicks on Submit with out first filling out all fields, a pop up should appear stating “Fill out all Fields to proceed.”

None

After 10 minutes of inactivity, log the user off of the server.

Error messages

None. 

Files accessed

Main Page, Reading Assessment Page, Quiz Page, Passage Database.  

Files changed

Reading Assessment Page, User Information.

Use Case 03: Passage Page 

Overview

The Passage Page contains the passage to be read by the user.  This passage is displayed after the “start” button is clicked by the user with their mouse.  When the “start” button has been clicked, the passage page retrieves a random passage from a database of passages and displays that passage.  The timer is also started, and a “stop” button appears at the end of the passage.  When the “stop” button is pressed, the timer is stopped and a link to the Quiz page appears. 

Preconditions

1. The user has logged in and the user data has been stored.
2. There is a database of passages that can be accessed.
3. The timer is available.

Scenario

Scenario Notes              

Actions 1 – 4 must occur in numerical order.  Action 5 may occur at any time.

 Post Conditions

1. The passage i.d. has been stored.
2. The reading time has been stored.
3. A database of quizzes for the passages exists.
4. The link to the Quiz Page or the link to the Main Page has been clicked.

Required GUI

Windows compatible Internet browser. 

Exceptions

1. The internet browser crashes, the operating system crashes, the internet browser is closed by the user, or the system loses its connection with the user in some other way:  the system logs the user out and deletes all data for that user.
2. The user is idle for too long:  the system logs the user out and deletes all data for that user.

Use Cases Utilized

Main Page use case, Quiz Page use case.

Timing Constraints

Overview

The Reading Tips page’s purpose is to provide the user with tips on reading. Refer to the Requirements document: 1.3 on the setup of the page

None

Scenario Notes

1 can be pressed at any time.

User is retuned to the main page

None

None

None

After 10 minutes of inactivity, log the user off of the server.

Use Case 05: Instructions Page

Overview

The Instructions Page is opened in a new window when the user clicks on the link for it.  Once the Instructions Page has been loaded, the instructions for the use of ReadSoft and a close button are displayed.

 Preconditions

1. The user’s CPU has enough memory to open a new internet browser window.

 Scenario

Scenario Notes              

Action 1 must occur first.  Action 2 can occur at any time following the execution of

Action 1.

Post Conditions

  The window that contained the Instructions Page has been closed and all data used for the Instructions Page and only for the Instructions Page has been deleted.

Required GUI

Windows compatible internet browser.

Exceptions

None.

Use Cases Utilized

Main Page use case.

Timing Constraints

Error messages

None 

Files accessed

Instructions Page. 

Files changed

None.

Use Case 06: Information Page 

Overview

The Information Page is displayed in the current window when the user clicks on the link for it.  Once the Information Page has been loaded, information about ReadSoft and a link to the main page are displayed. 

Preconditions

None. 

Scenario

Scenario Notes              

Action 1 must occur first.  Action 2 can occur at any time following the execution of

Action 1. 

Post Conditions

The internet browser has opened and displayed the Main Page. 

Required GUI

Windows compatible internet browser.

 Exceptions

1. The internet browser crashes, the operating system crashes, the internet browser is closed by the user, or the system loses its connection with the user in some other way:  the system logs the user out and deletes all data for that user.
2. The user is idle for too long:  the system logs the user out and deletes all data for that user.

Use Cases Utilized

Main Page use case. 

Timing Constraints

If the user is idle on this page for more than 10 minutes, the user is automatically logged out.

Use case 07: Reading Results Page

Overview

This web page shall display the reading time percentage and recall percentage of the user. A message shall also be displayed depending on the performance of the user. This page shall come up automatically after the last question of the reading assessment is answered. The interface shall have a link that gives the user the option to print the page. The reading time and number of questions gotten right by the user shall be stored in the database.

Preconditions

1. The user has logged in, read the passage and answered all 10 questions.
2. The database is accessible.

Scenario Notes

None

Post Conditions

1. The number of questions the user got right and the time in seconds of the user are stored in the database.
2. Text information is sent to the local printer if the uses click on the print button.
3. The user is redirected to the Reading Assessments main page.

Exceptions

1. The database is not accessible.
2. The printer is faulty.

Required GUI

1. GUI for the Reading Assessment main page.
2. GUI for the Results and Recommendations page.

Use cases Utilized

Uses the module select_appropriate_message.

Timing Constraints

The user shall be logged off after 10 idle minutes on the system.

Error Messages

none

Files Accessed

Database files

Files Changed

Database files

Error messages

None. 

Files accessed

Information Page, Main Page. 

Files changed

None.

Module Name: select_appropriate_message

Module Type: function, returns appropriate message.

Arguments: 1.) number of questions the user got right. 2.) how long it took reader to read passage in seconds.

Error messages: None

Files Accessed: database files

Files Changed: database files

Narrative: 

If reading time is less than average plus two standard deviations, then the following message is displayed.

"Your rate of reading as expressed as efficiency is considered normal for your input information"

If reading time is more than or equal to average plus to standard deviations, then give the following message:

"Based on your reading efficiency, it is recommended that you seek follow up professional assessment and determine appropriate accomodations to enhance academic performance. Some people with similar reading efficiencies have been diagnosed with learning disablities and greatly improve their academic performance with accomodations recommended by the professionals."

If recall percentage is above 65 percent, then print the following message:

"Your recall percentage is adequate for most academic work."

If recall percentage is less than 65 percent, then print the following message:

"Your recall percentage is low compared to other people of your age and other input information. It is recommended that you review the tips for improving reading and seek professional assessment and advice."

These messages shall be displayed on the evaluations page accordingly and will be included in the hard copy if the user chooses to print.

Use Case 08: Evaluations Page

Overview

This page allows the user to evaluate the Reading Assessment software by answering several questions. These questions are stored in the database. Each question has a scale from 1-7 that the user can select from. After answering all the questions, the user returns to the Reading Assessment main page by clicking the link that says "Back to Main Screen." The selections that the user makes are stored in the database. 

Preconditions

1. The user has to be logged in to select the link "Evaluation of This Tool" on the Reading Assessments main page.
2. The user has to have taken the reading assessment test to evaluate the tool.
3. The link "Evaluation of This Tool" has to be active for the user to get into the evaluations page.
4. The database is accessible.
5. The user has selected the ling "Evaluation of This Tool" on the main page and is currently in the Evaluations web page.

Scenario

Scenario Notes

Action 2. is the last of the sequence because this action takes the user out of the evaluations page. 

Post Conditions

1. The options picked by the user are stored in the database.
2. The user is returned to the Reading Assessment main page.

Exceptions

The database is not accessible.

Required GUI

GUIs for evaluations page and main page.

Use Cases Utilized

None

Timing Constraints

The user shall be logged off automatically after being idle for 10 minutes on the system.

Error Messages

None

Files Accessed

Database files

Files Changed

Database files

Implementation Platform

6.1 Development Platform

It is not currently described in the requirements document. Typically it is:

• Windows 2000 Server machine
• Running IIS 5.0
• FrontPage 2000 Extensions (or more recent version)
• SQL Server 2000

6.2 Client Delivery Platform

It is not currently described in the requirements document. Typically it is:

• Windows 2000 Server machine
• Running IIS 5.0
• SQL Server 2000
• Access via Internet Explorer version 4 (or later) or Netscape Navigator version 4 (or later)

Reference Materials

• Pfleeger, Shari Lawrence (2001). Software Engineering Theory and Practice.     Upper Saddle River, NJ : Prentice Hall.

To Do List

Requirements Issues List

Team Request Forms

NA

Cross-Reference Table

Revision History