Requirements Document                                                                      Created by: Members: Date: 

advertisement
Requirements Document
Created by:
Members:
Andrea Lau
Danny Lam
Jonathan Caparino
Josephine Chew
Date: April 22th, 2013
1
Table of Contents
Title
Page
I. Revision History
3
II. Document Overview
4
III. Background
5
IV. Statement of Work
5
V. Functional Requirements
7
VI. Nonfunctional Requirements
8
VII. Use Case Diagram
10
VIII. Use Case Descriptions
11
IX. Appendix
16
2
1. Revision History
Version
Date
Author
Detail of changes
1.0
04/22/13
All
Creation/First Draft
1.1
4/27/13
Jay Caparino
Added sections,
defined terms
1.2
5/5/13
Andrea Lau
Corrected based on
Vijay’s comments
1.3
5/6/13
Danny Lam
Updated
functional/non­functio
nal requirements and
created assumptions
table
1.4
5/7/13
All
Use case, Personas,
Assumptions
1.5
5/20/13
Danny
Updated
functional/non­functio
nal and assumptions
3
II. Document Overview
This is a living document listing all of the requirements for visuaLearn, a mobile application that
will be developed for the Down Syndrome Foundation of Orange County. Changes made will be
documented in the Revision History with the date of each change, and a note about what
changes occurred.
The document begins with a background about DSFOC, followed by our Statement of Work
describing our plan for the project, including the initial designs, research, development, testing,
and closing. Then the Functional & Non­Functional Requirements are listed. Following the
requirements is the Use Case Diagram and Use Case Descriptions. The last item of this
document is the Appendix that includes Assumptions and Definitions.
4
III. Background
Down Syndrome is a genetic condition in which an individual has a full or partial copy of
chromosome 21. This condition alters the development of an individual, both physically and
cognitively. It can significantly affect an individual’s ability to learn, especially at a young age.
Visual Learning is a teaching style that improves the learning experience for those with Down
Syndrome through sight and interaction.
The Down Syndrome Foundation of Orange County (DSFOC) runs a learning program to
help children with Down Syndrome. The program focuses on literacy, math, and speech
therapy. The organization has also created learning materials that are used within their program
and available online. However, these learning materials only exist in paper form and as PDF’s.
These don’t appeal to visual learners as well as a piece of interactive technology would.
There are several existing learning applications that are catered to visual learners, but
these do not align with the lesson plans the DSFOC has created.The DSFOC proposed the
creation of a supplemental mobile application to these workbooks where children are able to
engage with technology and have a more immersive experience with reading, math, various
activities, and learning as a whole.
IV. Statement of Work
Our project team will create an application for Android Tablets. The application will be the
foundation of what will be a mobile library of the entire DSFOC’s learning material library. Their
library consists of workbooks focusing on literacy and math. Other books focus on various
topics, such as “I See Colors”, “Music”, and “Pets”. We will focus on developing the mobile
version of the workbook titled “Going Places”. The physical copy of the workbook is available
for purchase through DSFOC’s website, here. Our application will guide students through a set
of basic activities including reading material, matching(which is broken down into matching
word to word, picture to picture, and picture to word), and finally sentence building. The goal of
the workbook is to help build vocabulary as well as reading comprehension through the
activities. The student will be encouraged to learn by interacting with our application.
For elicitation, our project team will keep in close contact with our client to discuss
project details. We’ve scheduled a weekly meetings to update each other. Each agenda for
each meeting will be focused on updating our client and questions we need to be answered for
the next phase of the project. Communicating through email, Google Hangout, and Skype will
serve as our communication mediums. We will use DropBox to obtain video files and pdf
versions of the workbooks from Dana.
5
For our initial designs, we will create basic sketches on paper. As time moves on, we will
begin to use Balsamiq, Photoshop, and other Wireframing tools. We will update our user
interface mockups frequently. This will involve frequently sharing our designs with the client.
We will also use our physical copy of “Going Places” as a reference. There is a consistency
throughout all of the DSFOC’s learning materials, in terms of images used, colors, fonts, and
formatting. To continue this consistency, we will base our design from these learning materials.
For development, we will begin reviewing Android Development. We will refer to previous
assignments and online documentation, whether it is official or in forums. We will make sure to
develop small things as the project progresses. We will start simple, testing basic
functionalities such as dragging and dropping objects. Since each group member does not
have their own tablet and there aren’t any tablets available that we could borrow at a low cost,
we will use existing emulators and test the app’s functionalities on Android phones(which we
have a number of already).
The future goal we hope this application will achieve is that each student will be able to access
the entire collection of DSFOC workbooks on their device. Creating this app will not only help
people with Down Syndrome, but visual learners worldwide too.
6
V. Functional Requirements
The following lists the functional requirements for the application. The requirements are
organized into different categories of user interaction activities. The goal of this project is to have
an application that meets the requirements below:
Must haves:
●
The application shall allow a user to select a book (click or tap) to open it.
○
each book has a title, cover image, audio file and a set of words
●
The application shall display reading content to the user
●
The application shall play audio of somebody reading the content to the user
○
The recording must be high­quality and excite the user
●
The application shall allow users to navigate back and forth through the reading content
●
The application shall allow students to complete a set of activities:
○
Drag & Drop (picture to picture, picture to word, or word to word)
■
The matching activity will allow users to drag a picture/word to another
picture/word.
■
A correct answer will place the word or picture over the matched object
■
The system shall accept a correctly dragged match in which the dragged
picture/word is moved to an area larger than the corresponding
picture/word
■
○
An incorrect answer will return the word or picture back to its original place
Flashcards
■
The system shall randomly display one picture at a time for the user to
speak out loud.
■
To validate their answer the user can click on the picture, which will flip
over and present an auditory answer as well as the word of the picture.
○
Pick It (Selecting a picture or word based on a visual cue)
■
The system will present either a picture or word in the center of the screen
with 6 choices at the bottom for them to select. (ex: The image is an
apple. There will be a couple of words: “pear”, “apple”, “orange”, etc.)
■
If the user selects the word “apple” an animation or check mark will
appear to indicate to the user that their answer is correct
■
If the answer is wrong then the screen could shake, or a “please try again”
message could pop up to let the user know to try again.
○
Line­Match
■
The system will present pictures/words on both sides of the screen
7
○
■
A correct answer will create a line between the matched objects
■
An incorrect answer will make the line disappear
Building A Sentence
■
The system shall allow users to drag words to form a sentence
■
A successfully built sentence means all words are placed in the correct
order before the user can move onto the next question
■
An incorrect placement of the words will return the words back to its
original location
●
●
The application shall provide a way to give feedback on the work the user has done
○
Reward for correct answer
○
Constructive and positive advice for wrong answers
Once the activity is complete the system will allow the student to continue onto the next
activity or go back to the main menu
●
The system shall be maintainable and updatable with new content.
●
The application shall allow users to click a button to continue onto the next page as well
to go back
●
The system shall play a triumphant sound when the user has correctly answered a
question within each activity excluding Flashcards
Nice to haves:
●
The system shall display multiple workbooks in an e­library.
●
The system should allow users to swipe to turn the page.
●
The system should have a feature for the user to repeat the tutorial process.
●
The application shall provide the user with short tutorials.
○
Pop­ups will show user basic navigation throughout app
Great to haves:
●
The system shall display all available workbooks in digitized form
●
The system shall allow users to purchase additional books
●
The system shall allow users to turn the page by swiping or clicking a button. (So both
implemented into the application)
●
The system shall indicate the successful completion of an activity with colorful firework
animations
∙
VI. Non-functional Requirements
●
The application should be available for purchase through the Google Play Store
8
●
●
The application should be available for purchase through the DSFOC Website
Each book shall have a topic that the user will be focusing on (ex: Going Places: will
focus on transportation)
● The application shall allow the student to learn at their own pace
●
The application shall encourage students to learn
●
The application must engage the users attention, use large, easy to read text, large and
clear images, and positive and reinforcing sounds
●
The audio recording of the content must sound enthusiastic and keep users’ attention
●
The voice in the app should have a soft voice (not robotic) and will guide the student
throughout the workbook
●
The application will be distributed through the Google Play Store (price not yet
determined)
●
Correct answers should be paired with positive responses (such as audio playing “Great
Job!” or playing fireworks, whistles, etc.)
●
The application should facilitate the use of intuitive finger gestures
●
The application should respond to the user’s interactions in a timely manner
●
The application should be easy to maintain and allow the sponsor to add new materials at
ease.
●
The application should be easy to navigate back and forth through the materials.
●
The application should allow the users to answer the question correctly before allowing
them to go to the next problem.
●
The activities should be able to be played multiple of times
9
VII. Use Case Diagram
10
VIII. Use Case Description
Use Case Name
Reading a Workbook
Use Case Description
The user reads a workbook by navigating
through multiple pages that displays
sentences. Each page contains one
sentence.
Revision History
5/7/2013
Actors
Students, Parents, Teachers
System Scope
Goal
The user has read all the sentences and has
gone through all the pages.
Level
Assumptions
User has an Android Tablet
Relationships
­includes
­extends
­extension points
A workbook includes the following activities:
matching, select, name, build,
Precondition
1.User must have downloaded the application
2.User has selected a workbook
Trigger Events
User input ­ touch. The user will either touch a
next or previous button, or swipe left to right
or right to left, to “flip” from page to page.
Basic Flow 1 (Main Success Scenario)
1. User opens up a workbook
2. User reads through the sentences and flips
the page.
3. User repeats step 2 until the all the end of
the workbook.
3. User moves onto activities.
Postconditions
Alternative Flow 1
User has the sentences read to them.
Alternative Flow 2
User has a teacher or parent read to them.
Alternative Flow 3
11
Exception Flow 1
User skips the reading section of the
workbook.
Activity Diagram
User Interface
Special Requirements
­ Performance Requirements
­ Reports
­ Data Requirements
Outstanding Issues
Use Case Name
Playing the Drag & Drop Activity
Use Case Description
A single image will be displayed to the user on
the left side of the screen. A set of images
containing that single image will be displayed
on the right side of the screen. The user will
then press and hold on the single image, and
drag it over, overlaying it on the same image
on the right side.
Revision History
5/7/2013
Actors
Children/students
System Scope
Goal
To complete the activity with all correct
answers
Level
Assumptions
User has an Android Tablet
Relationships
­includes
­extends
­extension points
This activity includes a set of words and
images that included in the reading material.
Precondition
1.User must have downloaded the application
2.User has selected a workbook
Trigger Events
User input ­ running finger across screen:
user can select an “item” (be it a picture or
12
word) can drag the box to corresponding
match
Basic Flow 1 (Main Success Scenario)
1. User is presented with a picture or word
they need to try to match
2. User drags said picture/word across
screen to matching picture/word
3. Once correctly matched, user is presented
a new picture/word to match
4. User repeats steps 2­3 until all
pictures/words are matched
5. Once user has completed matching all
answers correctly, user can go back to the
library, replay the activity, or continue to next
activity
Postconditions
1. Message from system to user indicating
completion of activity
Alternative Flow 3
Exception Flow 1
User skips the reading section of the
workbook.
Activity Diagram
User Interface
Special Requirements
­ Performance Requirements
­ Reports
­ Data Requirements
Outstanding Issues
Use Case Name
Using flashcards
Use Case Description
The user will navigate through “flashcards”.
They will see a picture of a keyword of that
workbook, and then name the object. They
can then tap anywhere on the “card” to flip the
card and view the word.
Revision History
5/21/2013
Actors
Students, Parents, Teachers
13
System Scope
Goal
The user has gone through all the flashcards
available.
Level
Assumptions
User has an Android Tablet
Relationships
­includes
­extends
­extension points
A workbook includes the following activities:
matching, select, name, build,
Precondition
1.User must have downloaded the application
2.User has selected a workbook
3. User has selected flashcards activity
Trigger Events
User input ­ touch. The user will tap the
screen to flip a card. They can then tap an
arrow to go on to the next card or go back a
card.
Basic Flow 1 (Main Success Scenario)
1. User opens up a workbook
2. User selects flashcards activity
3. User sees a picture of a lesson keyword
4. User names object and taps the screen to
flip to the word
3. User reaches end of activity, moves on to
others
PostConditions
1. Message from system to user indicating
completion of activity
Alternative Flow 1
User has the word read to them by system.
Alternative Flow 2
User has a teacher or parent read to them.
Alternative Flow 3
Exception Flow 1
User skips the flashcards activity of the
workbook.
Activity Diagram
User Interface
Special Requirements
­ Performance Requirements
14
­ Reports
­ Data Requirements
Outstanding Issues
15
IX. Appendix
Assumptions
Assumption
Status
Notes
Users should be able to work Validated by
on the lesson by themselves
without any help from a
teacher or parent
There will be a separate
process that will allow
parents to purchase
additional books
Validated by
The app will be free to
download with a couple
content available and
additional books can be
purchased afterwards
Validated by
For the activity “Naming a
picture”, the user can
practice for as long as they
like
Validated by
Users will be distracted if
Validated by
there is too much information
on the screen
Depending on the number of Validated by
books, the application will
require a scrolling feature
either left­right or top­down to
browse through the books
The books will be placed in a
particular order
Validated by
Each book will have a similar
UI
Validated by
The application should allow
users to swipe between
pages or click on a button to
go to the next page
Validated by
16
We will create the audio for
the audio portion of the app
Validated by
We will be developing for 10
inch tablets.
Validated by
Parents will begin to
purchase Android tablets
more after this application
has been developed
Validated by
Will users be able to choose
the activity they want to work
on
Validated by
Definitions
Down Syndrome
A genetic condition in which a person has 47 chromosomes instead of
46.
DSFOC
The Down Syndrome Foundation of Orange County. The organization
that the application is being developed for. The organization runs a
learning program that will incorporate the use of the application upon
completion.
Tablet
The device that the application will run on. Specific tablet(s) to be
determined.
Book
A book in the application contains the following: reading content, audio of
the reading content, and various activities which will be defined below.
Each book has a different subject or topic, e.g. math or literacy. We will
be focusing on the “Going Places” book.
Activity
Various processes and sequences users of the app will aim to complete.
Several activities of the app include reading, matching, drawing, and
sentence building.
Reading
An activity a user partakes in. A user can flip through various pages of
displayed text.
Sentence Building An activity a user partakes in after completing the reading task and the
matching activities. The user will select words from a word bank at the
top of the screen and place them onto blanks to build a complete
sentence.
17
Matching
A category of activities the user partakes in after completing the reading
task. This activity consists of three different types of matching
sequences: word to word, picture to picture, and word to picture. The
goal is to build comprehension by breaking down the matching activity
into three distinct sections.
Word to Word
A type of matching activity. The app displays words on the left and right
sides of the screen. Users then must match the same word by drawing a
line connecting the two or tapping the words consecutively (to be
determined).
Picture to Picture
A type of matching activity. The app displays images on the left and right
sides of the screen. Users then must match the same image by drawing
a line connecting the two or tapping the images consecutively (to be
determined).
Word to Picture
A type of matching activity. The app displays words on the left and
images on the right sides of the screen (or vice versa). Users then must
match a word with the corresponding image by drawing a line connecting
the two or tapping the two consecutively (to be determined).
Naming a Picture
An activity where the user is presented with a single image. The user will
either say what they think the picture is out loud to themselves or a
parent/teacher. To validate their answer they can click on the image
which will flip over with the answer.
18
Download