project management plan template · title: project management plan template author: daniel vitek...

STUDYUP

REQUIREMENTS DOCUMENT

Version <4.0>

<04/05/2017>

SFU Health++ <Project Group 01>

Owen Kwok

Mitchel Eppich

Leone Tory

Kitty Luo

STUDYUP REQUIREMENTS DOCUMENT VERSION <4.0>

TABLE OF CONTENTS

1 INTRODUCTION .................................................................................................................... 4

2 INTENDED AUDIENCE ........................................................................................................ 5

3 FEATURES/FUNCTIONAL REQUIREMENTS ................................................................ 5

3.1 1.0 Homepage ............................................................................................................ 5

3.2 2.0 Study Timer ......................................................................................................... 5

3.3 3.0 Profile .................................................................................................................. 6

3.4 4.0 Support ................................................................................................................ 6

3.5 5.0 Study Group ........................................................................................................ 6

3.6 6.0 Interactive Map ................................................................................................... 6

3.7 7.0 User Verification ................................................................................................. 6

4 NON-FUNCTIONAL REQUIREMENTS ............................................................................. 7

5 TUTORIALS ............................................................................................................................ 8

5.1 User Profile ............................................................................................................... 8

5.2 Study Timer ............................................................................................................... 9

5.3 Study Group ............................................................................................................ 10

5.4 Interactive Map ....................................................................................................... 12

5.5 Support .................................................................................................................... 12

5.6 Menu ........................................................................................................................ 12

5.7 Settings .................................................................................................................... 12

6 GLOSSARY ............................................................................................................................ 13

7 REFERENCES ....................................................................................................................... 14


of 14

VERSION HISTORY

Version # Implemented

By

Revision

Date

Status

1.0 Owen Kwok 02/16/2017 Created

1.1 Sebastian Meijerhof 02/22/2017 Added Introduction, Intended

Audience

1.2 Mitchel Eppich 02/23/2017 Updated Intended Audience;

Added Functional and Non-

Functional Req., Tutorials,

Glossary

1.3 Owen Kwok 02/23/2017 Created Table for Feature Priority

2.0 Everyone 02/24/2017 Final Revision

2.1 Owen Kwok 03/07/2017 Revised “Functional

Requirements”

2.2 Owen Kwok 03/07/2017 Revised “Tutorials”,

“Introduction”


Requirements” and “Non-

functional Requirements”

3.1 Owen Kwok 03/22/2017 Added updated photos to

“Tutorials”


Requirements” and “Non-

functional Requirements”

3.3 Owen Kwok 04/02/2017 Revised “Tutorials”

4.0 Owen Kwok 04/04/2017 Final Revision

Table 1: Revision History


of 14

1 INTRODUCTION

StudyUp is an iOS application where students can track their studying progress, find study

spaces, and collaborate with their classmates. The app includes three primary features: a study

timer, a map of campus study spaces, and a directory for creating and finding local study

groups.

The study timer will, when given a length of time for a given study session, delegate the time

between studying and taking breaks, leading to a more effective study method for the student.

In addition, the app tracks how much time the student spends studying for individual courses,

and compares that to the recommended 3 hours of studying time per course credit per week

[1]. This study timer results in more efficient studying for the student, and allows for accurate

progress tracking.

A database of study spaces around campus will also be available in StudyUp in the form of a

map, including information about available power outlets, nearby washrooms, and occupancy

throughout the day. This will allow students unfamiliar with the layout of the various SFU

campuses to find the perfect place to study based on their needs.

Finally, the app will allow students to host and browse study groups across campus. This

showcasing of study groups will allow students to easily connect with like-minded classmates

while simultaneously collaborating on classwork and discussing course topics.


of 14

2 INTENDED AUDIENCE

StudyUp is designed for students at Simon Fraser University looking to improve their study

habits and expand their social circles. We expect users to be familiar with navigating modern

mobile applications, such as SFU Snap, as well as the integrated Apple Maps application. In

order to utilize the online features, such as study groups and study sessions, the user must

have an active SFU e-mail address; the study timer and course study tracking features will be

available offline, and synchronize once an online connection is found. Finally, we expect users

to be familiar with the creation of events, such as with Facebook Events.

Users can utilize the app to assist them in reaching a variety of academic-related goals. The

user may wish to find like-minded individuals in their classes, and find new friends on campus

who allow them to thrive, both socially and academically. In addition, students may want to

accurately track and measure their studying progress in each of their courses throughout the

week, and to ensure an ideal balance between studying and breaks the timer feature can help

users reach that goal. StudyUp will also be appealing to students unfamiliar with SFU who

wish for assistance in finding their ideal studying environment around campus, and the ability

to track the occupancy of these spaces throughout the day.

3 FEATURES/FUNCTIONAL REQUIREMENTS

3.1 1.0 HOMEPAGE

The homepage will be main page of the application. It will be a navigational page for all

features included in the application.

1.1 The homepage will provide appropriate redirection buttons to each primary page.

1.2 The page will provide access to the ‘About’ page, which includes team information.

3.2 2.0 STUDY TIMER

This feature will allow users to set an amount for studying using the scroll wheel. The time

that the individual has studied for will be used to update and display the progress bars within

the user profile. The time recorded in the stopwatch is saved in a similar manner and will be

displayed in the user’s profile. If the application is run in offline mode, this will be the only

feature available. The user will be asked to enter their account email to save their offline

study data, or simply not record it.

2.1 The system will allow users to toggle the smart-study feature, which will set breaks

automatically throughout the user’s study period.

2.2 The system will allow the user to end their study session at any time without losing

progress data.

2.3 The system will allow users to select the course they are currently studying for.

2.4 The system will save study data in offline mode, if the user has entered in their account

email.


of 14

3.3 3.0 PROFILE

The application will display your profile information on this page. This includes your study

progress bars, profile description, profile picture, and faculty.

3.1 Users will be able to edit any profile information.

3.2 Users will be able to logout, clear study statistics, clear all account information, and

delete the user’s account from the database.

3.3 The system will display the user’s current documented progress in their studies and will

be able to add or delete courses.

3.4 The system will inform users of study goals depending on the credit hours of each course.

3.4 4.0 SUPPORT

4.1 Users will be able to access SFU Health Services using a redirection link to an external

browser.

4.2 Users will be able to contact SFU Security services directly from this page.

4.3 Users will have access to SFU recommended study guides and other academic help.

3.5 5.0 STUDY GROUP

There will be three types of study groups in this feature, ‘Open’ and ‘Closed’. Open and

closed groups will be searchable. Closed groups will have join requests sent by email.

5.1 Courses will be filtered in the format of (COURSE ID, TYPE).

5.2 Users requesting to join closed study groups will have a pending status until the study

group host responds. The user will not be able to see the exact location until accepted into

the study session. Once the user is accepted, they will be able to view the location.

5.3 The system will allow the host to change privacy settings, and location of the study group

at any time.

5.4 Any user will have the ability to call SFU Security services from this page.

5.5 All users will be able to search for and join an Open study group.

5.6 Private study groups will not show up in search results and are only accessible through

private invitation. A private invitation will send as an SMS.

3.6 6.0 INTERACTIVE MAP

6.1 The map will show study spaces and will show study groups that have been created.

6.2 Holding down in a location for 2 seconds will create a marker for the focal location.

6.3 All study spaces will be marked on the map with a pin. Tapping the pin will open a popup

with information on the study space.

3.7 7.0 USER VERIFICATION

7.1 The system will require you to login and sign up with the users SFU Computing ID.

7.2 Upon Sign-up of the application, the system will send a verification email to the SFU

email used.


of 14

4 NON-FUNCTIONAL REQUIREMENTS

1. The application must open to homepage in under 1 second.

2. It must take no longer than 5 seconds to load any in-app page.

3. Retrieving group locations from Firebase will take no longer than 10 seconds on an average

internet speed of 30 MB/s.

4. Posting a group’s location to Firebase will take no longer than 5 seconds on an average


5. Retrieving study spaces from Firebase will take no longer than 5 second on an average


6. Users will be able to set a study timer on average under 30 seconds.

7. No optional survey requested by the app will take longer than 1 minute to complete.

8. Surveys will take no longer than 10 seconds to post to Firebase on an average internet speed

of 30 MB/s.

9. Study group location information will take no longer than 5 seconds to retrieve from

Firebase on an average internet speed of 30 MB/s.

10. The user will be able to access the timer application within two redirections.

11. The user will be able to post a study group within three redirections.

12. The user will be able to join a study group within four redirections.

13. The application will take no longer than 30 seconds to download and install on an average


14. Study groups will take no longer than 2 seconds to end for the host.

15. When a study group ends, it will take no longer than 10 seconds for all members to receive

an alert from Firebase on an average internet speed of 30 MB/s.

16. Users will be able to find a suitable group on average in four redirections.

17. Users will be located in under 5 seconds on an average internet speed of 30 MB/s.

18. It will take no longer than 25 minutes to verify a user’s university email address on an

average internet speed of 30 MB/s when University networks are up.

19. Recent study data will take no longer than 1 minutes to be added to the user’s current

statistics on Firebase on an average internet speed of 30 MB/s.

20. Profile edits will take no longer than 10 seconds to upload to Firebase on an average internet

speed of 30 MB/s.

21. Study group create forms will take no longer than 3 minutes to complete on average.

22. User will be able to activate a study break with no redirections.

23. User will be able to resume study timer with no redirections.

24. User will be able to end study timer with no redirections.

25. User will be able to decline other users from study group access with no redirections.

26. User will be able to remove other users from study groups with one redirection.

27. Users will be removed from a study group on the request of the host in under 10 seconds on

an average internet speed of 30 MB/s.

28. Users will be able to access study group privacy settings within the study group creation

form.

29. Users will be able to join study groups via email if they have StudyUp already on their

device in under 30 seconds once the text is received.

30. Users will be able to terminate one’s own profile and all data will be removed in 5 seconds.

31. User course data will be removed from the database at the end of the semester per the SFU

academic calendar.


of 14

5 TUTORIALS

5.1 USER PROFILE Upon opening the application for the first time, you will be greeted with a ‘Sign Up’ page; if a

user already has an account, they can log in using their email and password. After entering in

required information, such as your name, provided university email address, and password you

will be sent an email featuring a verification code, which will need to be entered into the app

before gaining access to online features.

After creation, the user can access their profile at any time via the homepage. From this page,

the user can logout of the app and edit ambiguous information on their profile. Clicking

the settings gear icon on the top right will allow you logout, clear study progress on current

courses, clear all profile information, and terminate the user’s account.

Figure 2: User Profile Page Figure 1: StudyUp Homepage


of 14

5.2 STUDY TIMER

One can create a study session by visiting the from the homepage or quick menu. Once on the

timer page, you can set a duration for the study session, including breaks, via a scroll wheel. If

you are not sure how long to study for, use the stopwatch to record the length of your study

session. When enabled, StudyUp’s Smart Study will automatically implement break sessions

based on recommended study to break ratios. The main page can be seen in Figure 3.

After setting your session duration, simply press ‘Start Studying!’ to begin your study session.

You may manually start your break session at any time using the ‘Take a Break’ button;

otherwise, the Smart Study will suggest breaks by notification. Similarly, the ‘Resume’ button

will manually continue the study session countdown before Smart Study. At any time, you can

press the ‘End’ button to end your current session; verified accounts will have their session

data automatically synced. The session data at the end of the session will be sent to our database

that holds a user’s profile and course information. Using this data, it will update the progress

bars on the user profile.

Figure 1: Study Timer Main

Page Figure 4: Stopwatch Page


of 14

5.3 STUDY GROUP

After accessing the Study Group page from the quick menu or homepage, you can create a

group via a ‘Create Group’ button. After filling out a short form regarding study group

information and adjusting privacy settings, you can publish your group using the ‘Create’

button. Users will be able to browse other group member’s profiles by clicking on their name

on the group page. It will take them to the individual’s profile page, which will have the same

information, but with all course information hidden.

For ‘Open’ groups, individuals will be able to join the group from searching. If the host

receives a request to join a ‘Closed’ group, they may accept or reject the request and the user

requesting will be joined into the group. Before joining a ‘Closed’ group, the location of the

study space will be hidden. To find study groups, click the ‘Search’ switch and browse a list

of courses. After searching, select a group from the provided list to gain more information

about the group. If the group is open, press ‘Join’ to join the group; if the group is closed, press

‘Request’ to send a request to the group host, and join the group if you are accepted.

Figure 5: Group Creation (1) Figure 6: Group Creation (2)


of 14

Figure 7: Study Group Info Page

Within the group page, at the top right there is a messaging icon. Here you will be able to

contact members in the group through an instant messaging feature. You may report a user by

going to their profile page and pressing the ‘Report’ button at the top right. You will be asked

to fill out a short message explaining the violation; after pressing ‘Send,’ our system will be

notified. Clicking the alarm button at the top left, it will give you quick access to the timer

when studying in a group.


of 14

5.4 INTERACTIVE MAP

Once you access the Map page via the homepage, you may explore the app by dragging your

finger across the screen to pan the map and pinch to zoom. Verified study spaces are labelled

as black book markers on the Interactive Map, making them easily seen. Study groups seen

on the maps will be categorized by the following types and color:

Blue: Silent

Green: Social

Orange: Cramming

To gain more information about a particular study group, simply click on the marker.

INSERT PIC

5.5 SUPPORT

While in the Support page, accessible from the homepage or quick menu, you may select any

tab that will bring you to an external SFU webpage not owned by our project.

5.6 MENU

The menu can be accessed on any page using the house icon at the top left corner of the screen.

Tapping the icon will redirect you to the homepage, allowing you to access any main page of

the application.

5.7 SETTINGS

Settings can be accessed by tapping on the gear in the top right area of the screen in the user

profile. In settings, you will be able to logout of your profile, clear course statistics, clear profile

information or delete your account.


of 14

6 GLOSSARY

Ambiguous Information: Any information which is not directly connected to the user,

such as interests, courses, etc.

Closed study group: study groups that will appear in search results but requires the group

host to authorize the attendance of any student requesting to join the group.

Focal location: The location that is being focused on by the user.

Interactive map: A map providing location and availability of study spaces.

Primary page: Interactive maps, study groups, profile, support and timer are all

categorized as primary pages.

Private study group: study groups that will not show up in search results and can only be

joined via invitations sent by the host.

Open study group: study groups that will show up in search results and do not require

verification when a student chooses to attend.

Menu: This will be a redirection to the application homepage.

Redirection button: when a user moves from one page to another using a graphical user

interface button.

Smart Study: A 5:1 ratio of studying to taking a break as ideally for every hour there is

50 minutes of studying and 10 minutes of time for break taking.

Study group: a collection of users who will meet in a common space to study a common

course.

Studying progress: a measure of how many hours of study a student has logged for a given

course compared to a target number of hours. The default target will be calculated as three

hours for every course credit hour.

Study session: a user specified amount of time that will be used to focus on a user identified

course.

Study space: a suitable location for students to populate which is able to satisfy such needs

as power outlets, seating and all forms of study styles.

Suitable group: A group that meets the user’s needs, including a suitable size, type, and

location

Support: A page containing links to SFU security and SFU health & Counselling Services.

Termination: Complete removal of user's account from the StudyUp database.


of 14

7 REFERENCES

[1] D. McGee-Thompson, “How to Study Efficiently and Effectively,” lib.sfu.ca, para. 2, Apr.

25, 2016. [Online]. Available: http://www.lib.sfu.ca/about/branches-depts/slc/learning/exam-

prep/efficient-effective-study. [Accessed: Feb. 22, 2017].

[2] S. Ng, "iOS Programming 101: How To Send SMS Text Message in iPhone

Apps", Appcoda.com, 2017. [Online]. Available: http://www.appcoda.com/ios-programming-

send-sms-text-message/. [Accessed: 07- Mar- 2017].

http://www.lib.sfu.ca/about/branches-depts/slc/learning/exam-prep/efficient-effective-study

http://www.lib.sfu.ca/about/branches-depts/slc/learning/exam-prep/efficient-effective-study

project management plan template · title: project management plan template author: daniel vitek...

Documents