Readingful Web Development Specifications

Public

Homepage_25/35

Search_24/27

Login_50/60

Learn More_33/36

Sign Up_39/59

System Emails_0/77

 

Information

Overview

Misc

Color Map

 

Completion Key

0-40%

41-90%

91-100%

 

 

Students

Story Library_2/23

-- User Profile and Navigation_14/22

-- Leaderboard_0/25

-- Avatar Store_0/43

Story_33/62

-- Quiz_25/96

-- Quiz Results_0/34

Teacher

Teacher Dashboard_15/26

Students_12/46

-- Student Account Creation_84/86

-- Mass Account Creation_22/23

-- Progress Reports_9/29

-- Global Password_26/27

-- Student Credentials_35/35

-- Student Profile_0/169

Stories_44/103

Subscription_42/50

-- Extend Access_75/77

-- Receipt_15/15

-- Add Students_64/64

-- Payment History_12/14

-- Benefactor Checkout_49/50

My Account_0/89

Helpbook_27/94

Admin

Admin Dashboard_9/16

-- Users_48/57

-- Stories (admin)_79/133

-- Activity_0/42

-- Settings_0/93

-- Helpbook (admin)_46/144

 

Critical

Critical Task List

Work Order #13 ( Quiz Stage 1 )

Wrapping up "Quiz Stage 1" with additional functional refinements and revisions.

Included Tasks: SQ1.2-6, 7, 8, 16, 20, 21, 23, 24, 26, 29-42, 44-52, 54-67, 72-79, 81, and 85-89 in the Quiz Stage 1 Function Checklist.

Precursor: "Story Package" upload and data migration should be working correctly first.

 

Work Order #14 ( Helpbook - Category Menu ) - Last Reviewed: 7/26

Fabricating Readingful's category menu of the "Helpbook," as well as the admin function for creating menu sections.

Included Tasks: HB.2, 3, 5, 7, 8, 12-15, 17 and 18 in the Helpbook Function Checklist and HBA.2, 3, 5, 9, 17, 24, 26, 27, 29, 31-32a, 33a, 34 and 36 in the Helpbook (Admin) Function Checklist

Precursor: None

 

Work Order #15 ( Learn More ) - Last Reviewed: 7/26

Only a few minor edits remain to complete this work order.

Included Tasks: LM.3 and 29 in the Learn More Function Checklist.

Precursor: None

 

Work Order #16 ( Search ) - Last Reviewed: 7/26

Missing function and permission limitations for Readingful's "Story Search."

Included Tasks: SE.12, 17 and 24 in the Search Function Checklist.

Precursor: None

 

Work Order #17 ( Story ) - Last Reviewed: 7/27

Small styling changes, adjustments to text paragraph function, and bug fixes for loading/displaying images within the platform's "Story Reading" process.

Included Tasks: SR.30, 31, 33, 39, 49 (excluding iPad bug) and 59 in the Story Function Checklist.

Precursor: None

 

Work Order #18 ( Story - Reading Level Selector ) - Last Reviewed: 7/27

Involves building (it may be partially finished already) and implementing the "Reading Level Selector" that allows teachers and admins to change the reading level of the "Story."

Included Tasks: SR.40-45 in the Story Function Checklist.

Precursor: None. However, will require a "Story Package" upload with more than one level/version of the text for testing purposes.

 

Work Order #19 ( Story - Guest User Warning Modals ) - Last Reviewed: 7/27

This work order involves crafting the two modals that show to a guest user when clicking the "Read It" button on the homepage.

Included Tasks: SR.5-9 and 9-13 in the Story Function Checklist.

Precursor: None

 

Work Order #20 ( Story - iPad )

In terms of Readingful's "Story Reading" process, much of it either doesn't work, or is buggy, specifically on the iPad, while it works in PC browsers.

Included Tasks: SR.17, 22, 29, 39 (only the iPad bug), 47, and 48 in the Story Function Checklist.

Precursor: Work Orders #17, 18, and 19

 

Work Order #21 ( Login Step 1 ) - Last Reviewed: 7/27

Addressing bugs, missing functions, adding the module close button, and font formatting/styling adjustments to the "Username" step of the platform login process.

Included Tasks: L.1, 5 and 6 in the Login Function Checklist.

Precursor: None

 

Work Order #22 ( Login Step 2 ) - Last Reviewed: 7/27

Addressing bugs, missing functions/authentication conditions, and font formatting/styling adjustments to the "Password" step of the platform login process.

Included Tasks: L.34, 46a, 50, and 57 in the Login Function Checklist.

Precursor: None

 

Work Order #23 - REDACTED

 

Work Order #24 - REDACTED

 

Work Order #25 - REDACTED

 

Work Order #26 ( Helpbook - Article List ) - Last Reviewed: 7/28

Creating the "Article List of the "Helpbook," as well as the admin function for creating article titles.

Included Tasks: HB.20-22, 24 and 26-28 in the Helpbook Function Checklist and HBA.37-39, 40, and 43 in the Helpbook (Admin) Function Checklist.

Precursor: Work Order #14

 

Work Order #27 ( Sign Up - Adding Role Selection Step ) - Last Reviewed: 7/28

This work order is to add a new additional step to the account "Sign Up" process to differentiate between a parent and a teacher account.

Included Tasks: SU.4-6 in the Sign Up Function Checklist.

Precursor: None

 

Work Order #28 ( Sign Up - Revisions and Adjustments ) - Last Reviewed: 7/28

Various revisions and adjustments Readingful's new account "Sign Up" process.

Included Tasks: SU.8, 11, 12, 14, 26, 36-38, 40, 49, 50, 52, 53 and 56 in the Sign Up Function Checklist.

Precursor: Work Order #27

 

Work Order #29 ( Helpbook - Creating Articles ) - Last Reviewed: 7/28

The admin process for creating articles in the "Helpbook," as well as their display.

Included Tasks: HB.31-38 in the Helpbook Function Checklist and HBA.51, 54, 55, 57-60, 64, 69, 71, 72, 74, 77-80, and 82 in the Helpbook (Admin) Function Checklist.

Precursor: Work Order #26

 

Work Order #30 ( Helpbook - Article Search ) - Last Reviewed: 7/28

Configuring the module that allows teachers to search the "Helpbook,", as well display the results. Note: Search function already exists in admin/teacher accounts.

Included Tasks: HB.44-46, 50 and 53 in the Helpbook Function Checklist.

Precursor: Work Order #29

 

Work Order #31 ( Helpbook - Quicktorials Module )

Creating the module that allows teachers to browse all instructional videos offered in the "Helpbook" in one place.

Included Tasks: HB.56-76 in the Helpbook Function Checklist and HBA.51-82 in the Helpbook (Admin) Function Checklist.

Precursor: Work Order #30

 

Work Order #32 ( Helpbook - Uploading/Creating a Quicktorial Entry )

The admin function for uploading a video, creating its entry, and editing/deleting entries.

Included Tasks: HBA.83-142 in the Helpbook (Admin) Function Checklist.

Precursor: Work Order #31

 

Work Order #33 ( Helpbook - Request Assistance ) - Last Reviewed: 7/28

Creating the module and form field that allows teachers to submit a request for help. Note: A similar function already exists in "Learn More" section. Draft from it.

Included Tasks: HBA.78, 80-85, 87-89, and 91-94 in the Helpbook Function Checklist and BC.47 in the Benefactor Checkout Function Checklist.

Precursor: None

 

Work Order #34 - REDACTED

 

Work Order #35 - REDACTED

 

Work Order #36 ( Quiz Stage 4 )

Showing the results of the quiz to the student, as well as the number of coins earned/avatars unlocked, while ensuring the fidelity of the data recorded.

Included Tasks: SQ4.1-30 in the Quiz Stage 4 Function Checklist, LM.21 in the Learn More Function Checklist and SR.61, 62 in the Story Function Checklist.

Precursor: Work Order #35

 

Work Order #37 ( Stories Admin - Adjustments and Revisions )

Styling and function adjustments/revisions to the "Stories (Admin)" section, specifically the "Stories Table." Note: Completing the admin version of the "Stories" module will undoubtedly complete almost all of the issues in the teacher's version, as they mirror each other.

Included Tasks: STOA.2, 3, 7-9, 13, 16, 31, 33, and 37 in the Stories (Admin) Function Checklist.

Precursor: None

 

Work Order #38 ( Stories Admin - Story Search and Individual Entry )

Revisions and bug fixes for the existing "Story Search" and "Story Entry" modules.

Included Tasks: STOA.58, 59, 62, 63, 66-69, 71, 76, 78, 80, 82, 84-88, 90 and 91 in the Stories (Admin) Function Checklist.

Precursor: Work Order #37

 

Work Order #39 ( Stories Admin - Story Upload ) - Last Reviewed: 7/29

Bug fixes and adjustments to the admin function for uploading, replacing, and deleting "story packages" in the "Stories (Admin" section.

Included Tasks: STOA.97-99, 109-112, 116-123, 126-129, and 130-133 in the Stories (Admin) Function Checklist.

Precursor: Work Orders #17-19, and 38

 

Work Order #40 ( Stories - Pinning and Bookmarking Stories )

Creating the functions for pinning/bookmarking stories. These may already exist in some form. The "Story Entry" in the "Stories" section of the teacher account isn't currently loading. The first step is to make that occur, so these functions can be checked. Note: Although there are many other items in the "Stories" section to be checked, the work orders involving the admin version of this area should also take care of almost all of them.

Included Tasks: STOR.78-84, 86-95, and 97-99 in the Stories Function Checklist.

Precursor: Work Orders #37, 38, and 39

 

Work Order #41 ( Students - Students Table )

Revisions and bug fixes for the existing "Students Table" in the teacher's "Students" section.

Included Tasks: ST.2-5, 7, 9, 14-17, 20-26, 28 and 30-34 in the Students Function Checklist SR.4 in the Story Function Checklist.

Precursor: Work Order #35 (Not entirely necessary, but important for checking the table data updates as students take quizzes).

 

Work Order #42 ( Student Profile - Main Data Table )

Fabricating the main data table for the teacher's "Student Profile" module .

Included Tasks: SP.1-18 in the Student Profile Function Checklist.

Precursor: Work Orders #35, 40, and 41

 

Work Order #43 ( Student Profile - Editing Modules )

Creating the modules for editing various values and terms/strings of data in the teacher's "Student Profile."

Included Tasks: SP.19-63, 66-74 and 122-129 in the Student Profile Function Checklist.

Precursor: Work Order #42

 

Work Order #44 ( Student Profile - Data Points )

Configuring the non-editable values/data points that print in the "Student Profile."

Included Tasks: SP.64, 65 and 75-77 in the Student Profile Function Checklist.

Precursor: Work Order #43

 

Work Order #45 ( Student Profile - Question Answer Record )

Creating the module that shows the underlying data, by skill, for each student in the "Student Profile" section.

Included Tasks: SP.78-81 in the Student Profile Function Checklist.

Precursor: Work Order #44

 

Work Order #46 - REDACTED

 

Work Order #47 - REDACTED

 

Work Order #48 - REDACTED

 

Work Order #49 ( Student Profile - Settings )

Implementing the "Settings" teachers can enable/disable for individual students in the "Student Profile" table.

Included Tasks: SP.130-168 in the Student Profile Function Checklist, L.49 in the Login Function Checklist, and GP.27 in the Global Password Checklist.

Precursor: Work Order #48

 

Work Order #50 ( Progress Reports )

Bug fixes to the "Progress Reports" module, as well as PDF generation of the overview of the student's question/answer record data.

Included Tasks: SP.130-168 in the Progress Reports Function Checklist.

Precursor: Work Order #49

 

Work Order #51 ( Story Library )

Missing function, revisions, and bug fixes to the "Story Library" components, mostly the "Story Selector Array."

Included Tasks: STL.3-23 in the Story Library Function Checklist and UPN.15-19 in the User Profile and Navigation Function Checklist.

Precursor: Work Order #36

 

Work Order #52 - REDACTED

 

Work Order #53 ( Leaderboard )

Fabrication of the student account "Leaderboard" module.

Included Tasks: SL.1-25 in the Leaderboard Function Checklist.

Precursor: Work Order #51

 

Work Order #54 ( Students - Leaderboard )

Fabrication of the "Leaderboard" accessible to the teacher in the "Students" Section. Function mirrors that of the student account leaderboard.

Included Tasks: ST.35 and 37-45 in the Students Function Checklist.

Precursor: Work Order #53

 

Work Order #55 ( Avatar Store - Array Module )

Creating the student "Avatar Store" array module.

Included Tasks: AS.3-24 in the Avatar Store Function Checklist.

Precursor: Work Order #51

 

Work Order #56 ( Avatar Store - Infoblock and Purchasing Function )

Coding the styling and function for the "Avatar Store" loading, infoblock display, purchasing, and equipping.

Included Tasks: AS.1-2, and 25-43 in the Avatar Store Function Checklist and UPN.20-22 in the User Profile and Navigation Function Checklist.

Precursor: Work Order #55

 

Work Order #57 ( Subscription ) - Last Reviewed: 7/29

Bug fixes and menu adjustment for the "Subscription" section of the teacher account.

Included Tasks: STA.1, 4, 5, 8, 9, 12, 27 and 47 in the Subscription Function Checklist.

Precursor: None

 

Work Order #58 ( Teacher Dashboard ) - Last Reviewed: 7/29

Crafting the initial welcome message for brand new teacher accounts, as well as other minor bug/styling fixes.

Included Tasks: TD.3, 8, 10, 11, 14, 16, 17, 19, 20, 25 and 26 in the Teacher Dashboard Function Checklist.

Precursor: None

 

Work Order #59 ( Admin Dashboard ) - Last Reviewed: 7/29

Minor bugs and styling tweaks to the opening of the admin account.

Included Tasks: Ad.1, 4, 10-13, and 16 in the Admin Dashboard Function Checklist.

Precursor: None

 

Work Order #60 ( Users ) - Last Reviewed: 7/29

Bug fixes for the function of the admin's "Users Table" and "User Search" module.

Included Tasks: USR.5, 7, 28, 31, 34 and 37-41 in the Users Function Checklist.

Precursor: None

 

Work Order #61 ( My Account - Status )

Opening of the main module, as well as creating the "Account Status" module which allows the teacher to deactivate the account and mark it for deletion.

Included Tasks: MYA.1-25 in the My Account Function Checklist.

Precursor: None

 

Work Order #62 ( My Account - User Identity, Contact Information, and Password Update Settings )

Creating the settings modules that allow the teacher to update his or her name, email address, and password

Included Tasks: MYA.26-75 in the My Account Function Checklist.

Precursor: 61

 

Work Order #63 ( My Account - Background Image Setting )

Creating the settings module that allows the teacher to change the account background image.

Included Tasks: MYA.76-89 in the My Account Function Checklist.

Precursor: 62

 

Work Order #64 ( Admin Settings - Module Loading and Menu)

Coding the admins "Settings" menu and general loading of the module. Note: Admin account requires all settings from the teacher account to load, as well.

Included Tasks: SET.1-10 in the Settings Function Checklist.

Precursor: 63

 

Work Order #65 ( Admin Settings - Background Images Setting )

Creating the setting that allows the admin to upload/update the set of background images for the admin and teacher areas.

Included Tasks: SET.11-20 in the Settings Function Checklist.

Precursor: 64

 

Work Order #66 ( Admin Settings - Offline Mode Setting )

Creating the setting that allows the admin to sign out all users and restrict access to only the admin.

Included Tasks: SET.21-30 in the Settings Function Checklist.

Precursor: 64

 

Work Order #67 ( Admin Settings - Student Passwords )

Creating the setting that allows the admin to update the list of possible passwords from which new student accounts are randomly assigned

Included Tasks: SET.31-39 in the Settings Function Checklist and SAC.67 in the Student Account Creation Function Checklist.

Precursor: 64

 

Work Order #68 ( Admin Settings - Pricing and Free Trial Period Settings )

Creating the setting that allows the admin to update the base subscription price for teacher and parent accounts, as well as the pricing for for teachers to add students, and set the free trial period.

Included Tasks: SET.40-48 and 85-93 in the Settings Function Checklist, EA.14 in the Extend Access Function Checklist.

Precursor: 64

 

Work Order #69 ( Admin Settings - Account Purging )

Creating the setting that allows the admin to update the period of time at which abandoned teacher accounts are purged.

Included Tasks: SET.49-57 in the Settings Function Checklist.

Precursor: 64

 

Work Order #70 ( Admin Settings - Reading Limit Setting )

Creating the setting that allows the admin to limit the number of texts a student may begin reading over a certain period of time.

Included Tasks: SET.58-66 in the Settings Function Checklist.

Precursor: 64

 

Work Order #71 ( Admin Settings - Styling Override )

Creating the setting that allows the admin to override any site styling.

Included Tasks: SET.67-75 in the Settings Function Checklist.

Precursor: 64

 

Work Order #72 ( Admin Settings - Terms of Service )

Creating the setting that allows the admin to update the text of the platform's "Terms of Service."

Included Tasks: SET.76-84 in the Settings Function Checklist.

Precursor: 64

 

Work Order #73 ( System Emails )

Fabricating the 5 emails Readingful needs configured, three of which are user activated, two will run off cronjobs on the server.

Included Tasks: SE.1-77 in the System Emails Function Checklist, and L.38 in the Login Function Checklist, and SU.55 in the Sign Up Function Checklist.

Precursor: None

 

Work Order #74 ( Activity )

Programming the admin's "activity" graph.

Included Tasks: ACT.1-42 in the Activity Function Checklist.

Precursor: Platform should be nearly finished.

 

Work Order #75 ( Homepage )

Final adjustments to the platform's responsitivity to narrower height displays, bug fixes, and updates to the site's meta data.

Included Tasks: HP.1, 2, 8, 17 and 31-34 in the Homepage Function Checklist.

Precursor: Platform should be nearly finished.