Blame view

DesignUseCases.tex 51.3 KB
9bdef2907   Andrew Buss   Converted design ...
1
2
3
4
5
6
7
8
9
10
  \documentclass[letterpaper]{scrartcl} % or whatever
  \usepackage{tgpagella}
  \setkomafont{disposition}{
  ormalfont\bfseries}
  %\usepackage[markuppercase]{scrpage2}
  \title{\huge Design Use Cases}
  \date{\today}
  \author{\Large Students With A Goal (S.W.A.G.)}
  \usepackage[pass]{geometry}
  \usepackage{hyperref}
5a8fe752e   Andrew Buss   Added logo
11
  \usepackage{graphicx}
9bdef2907   Andrew Buss   Converted design ...
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
  \usepackage{enumitem}
  \setlist[description]{style=multiline,leftmargin=3cm,font=
  ormalfont\textbf}
  \setlistdepth{9}
  
  \setlist[itemize,1]{label=$\bullet$}
  \setlist[itemize,2]{label=$\bullet$}
  \setlist[itemize,3]{label=$\bullet$}
  \setlist[itemize,4]{label=$\bullet$}
  \setlist[itemize,5]{label=$\bullet$}
  \setlist[itemize,6]{label=$\bullet$}
  \setlist[itemize,7]{label=$\bullet$}
  \setlist[itemize,8]{label=$\bullet$}
  \setlist[itemize,9]{label=$\bullet$}
  \renewlist{itemize}{itemize}{9}
  \begin{document}
  \maketitle
  \begin{center}
5a8fe752e   Andrew Buss   Added logo
30
  \includegraphics[width=12cm]{../swag_logo.png}\\
9bdef2907   Andrew Buss   Converted design ...
31
32
33
34
35
36
37
38
39
40
41
42
43
  \begin{tabular}{l r}
  Melody Jeng & System Architect \\
  Arno Gau & Senior System Analyst \\
  Rachel Lee & Software Development Lead \\
  Laura Hawkins & Project Manager \\
  Rohan Rangray & Algorithms Specialist\\
  Andrew Buss & Database Specialist \\
  Phuong Tran & Quality Assurance Lead \\
  Chung Kang Wang & Business Analyst\\
  Masud Rahman & User Interface Specialist\\
  Kevin Mach & User Interface Specialist\\
  \end{tabular}
  \end{center}
b295f14e2   Andrew Buss   Moved TOC to new ...
44
45
  
  ewpage
9bdef2907   Andrew Buss   Converted design ...
46
47
48
  \tableofcontents
  
  ewpage
de8099363   Laura Hawkins   half of the desig...
49

9bdef2907   Andrew Buss   Converted design ...
50
51
52
53
54
55
56
57
58
  \section{Accounts}
  \subsection{[A1] User Registration}
  \begin{description}[style=multiline,leftmargin=3cm]
  \item[Description]{To create and save decks, the system requires the user
  to create an account prior. The user will be able to create an account
  through registering.}
  \item[Desired Outcome]{An account will be created for the user from the
  specified username, password, email. The user will be able to log into
  the aforementioned account.}
45b5ec6b5   Andrew Buss   Fixed description...
59
  \\
9bdef2907   Andrew Buss   Converted design ...
60
  \item[User Goals]{The user shall have an account to participate in the
de8099363   Laura Hawkins   half of the desig...
61
  application's activities.}
9bdef2907   Andrew Buss   Converted design ...
62

45b5ec6b5   Andrew Buss   Fixed description...
63
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
64

45b5ec6b5   Andrew Buss   Fixed description...
65
66
67
  \item[Dependency Use Cases]{None}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
68

de8099363   Laura Hawkins   half of the desig...
69
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
70

de8099363   Laura Hawkins   half of the desig...
71
  \item[Pre-conditions]: None.
9bdef2907   Andrew Buss   Converted design ...
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The user has an account registered with the system.}
  \end{itemize}
  
  \item[Trigger]{The user wants to create an account.}
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
88
89
90
    {The frontend renders the login form described in login.html.}
  \item
    {The User shall click the sign up toggle.}
9bdef2907   Andrew Buss   Converted design ...
91
  \item
de8099363   Laura Hawkins   half of the desig...
92
    {The frontend shall render a registration form and display it to the User.}
9bdef2907   Andrew Buss   Converted design ...
93
  \item
de8099363   Laura Hawkins   half of the desig...
94
    {The User shal fill in the form.}
9bdef2907   Andrew Buss   Converted design ...
95
  \item
de8099363   Laura Hawkins   half of the desig...
96
    {The frontend checks that the provided email is not invalid, and that
9bdef2907   Andrew Buss   Converted design ...
97
98
99
    the password is not valid. If anything is not valid, it displays an
    error and returns this to the user. }
  \item
de8099363   Laura Hawkins   half of the desig...
100
101
    {If the form is valid, the frontent POSTs the form in JSON format to the
    server API at /api/verify\_email/.}
9bdef2907   Andrew Buss   Converted design ...
102
  \item
de8099363   Laura Hawkins   half of the desig...
103
104
    {The backend deserializes and validates the data in /api/register. If it's not valid, it
    returns an error to the frontend.}
9bdef2907   Andrew Buss   Converted design ...
105
  \item
de8099363   Laura Hawkins   half of the desig...
106
107
    {The backend creates a new User object from the provided data, filling
    in the email and password fields in models.py in model method create\_user.}
9bdef2907   Andrew Buss   Converted design ...
108
  \item
de8099363   Laura Hawkins   half of the desig...
109
    {The backend saves the User object in models.py.}
9bdef2907   Andrew Buss   Converted design ...
110
  \item
de8099363   Laura Hawkins   half of the desig...
111
    {The backend marks the User's email as unverified.}
9bdef2907   Andrew Buss   Converted design ...
112
  \item
de8099363   Laura Hawkins   half of the desig...
113
114
    {The backend sends an email to the User's address with a link to
    validate the user's email address from models.py in function send\_confirmation\_email.}
9bdef2907   Andrew Buss   Converted design ...
115
  \item
de8099363   Laura Hawkins   half of the desig...
116
117
    {The backend responds with success and logs the User in on a new
    session for the User. }
9bdef2907   Andrew Buss   Converted design ...
118
  \item
de8099363   Laura Hawkins   half of the desig...
119
    {The frontend reports success to the User and stores the sessionid for
9bdef2907   Andrew Buss   Converted design ...
120
121
    future requests.}
  \end{enumerate}
9bdef2907   Andrew Buss   Converted design ...
122
123
124
125
126
  {Verification Workflow:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
127
128
    {The User receives an email with a link to verify their email. The
    User clicks the link}
9bdef2907   Andrew Buss   Converted design ...
129
  \item
de8099363   Laura Hawkins   half of the desig...
130
    {The frontend in VerifyEmailController submits a POST request to the backend.}
9bdef2907   Andrew Buss   Converted design ...
131
  \item
de8099363   Laura Hawkins   half of the desig...
132
133
    {The backend validates the code in views.py in function veryify\_email. If the code is not valid, it returns
    an error to the frontend.}
9bdef2907   Andrew Buss   Converted design ...
134
  \item
de8099363   Laura Hawkins   half of the desig...
135
136
    {The backend marks the user's email as confirmed and saves the User object
    again in models.py in function confirm\_email. The user's account is now active.}
9bdef2907   Andrew Buss   Converted design ...
137
  \item
de8099363   Laura Hawkins   half of the desig...
138
    {The frontend's VerifyEmailController.js reports success and logs the User in to the application. }
9bdef2907   Andrew Buss   Converted design ...
139
140
141
142
143
144
  \end{enumerate}
  
  \end{description}
  
  
  ewpage
770e764f2   Melody   Might have possib...
145
  \subsection{[A2] User Login}
9bdef2907   Andrew Buss   Converted design ...
146
147
148
  
  \begin{description}
  \item[Description]{User is able to login to personal account.}
45b5ec6b5   Andrew Buss   Fixed description...
149
  \item[Desired Outcome]{The user shall be able to provide their username and
9bdef2907   Andrew Buss   Converted design ...
150
151
152
  password to access their courses and flash cards. The user shall gain
  access to the list of the courses they have added, and be able to review
  the flash cards they have added to their decks.}
45b5ec6b5   Andrew Buss   Fixed description...
153
  \\
9bdef2907   Andrew Buss   Converted design ...
154
155
  \item[User Goals]{The user wants to resume use of the site on another
  device, or use the site after logging out.}
45b5ec6b5   Andrew Buss   Fixed description...
156
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
157

45b5ec6b5   Andrew Buss   Fixed description...
158
159
160
  \item[Dependency Use Cases]{{[}A1{]} User Registration}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
161

de8099363   Laura Hawkins   half of the desig...
162
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
163
164
165
166
167
168
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
169
170
    {The User has registered an account.}
    {The User knows their email and password.}
9bdef2907   Andrew Buss   Converted design ...
171
172
173
174
175
176
177
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
178
    {The User can navigate the site and see their data.}
9bdef2907   Andrew Buss   Converted design ...
179
  \end{itemize}
de8099363   Laura Hawkins   half of the desig...
180
  \item[Trigger]{The User wants to use the application and its core features.}
9bdef2907   Andrew Buss   Converted design ...
181
182
183
184
185
186
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
187
188
189
  {The frontend shall render the login form described in login.html and implemented in LoginController.js}
  \item
  {The User shall type in their email and password.}
9bdef2907   Andrew Buss   Converted design ...
190
  \item
de8099363   Laura Hawkins   half of the desig...
191
    {The backend shall verify that the User has submitted their email and password in views.py in function login.}
9bdef2907   Andrew Buss   Converted design ...
192
  \item
de8099363   Laura Hawkins   half of the desig...
193
    {The backend shall check that the User is active in views.py in function login.}
9bdef2907   Andrew Buss   Converted design ...
194
  \item
de8099363   Laura Hawkins   half of the desig...
195
196
197
    {The backend shall log the User in using the Django login feature.}
  \item
    {The frontend shall displays the home page for the User.}
9bdef2907   Andrew Buss   Converted design ...
198
  \end{enumerate}
45b5ec6b5   Andrew Buss   Fixed description...
199
  \end{description}
9bdef2907   Andrew Buss   Converted design ...
200
201
  
  ewpage
770e764f2   Melody   Might have possib...
202
  \subsection{[A3] Add a Class}
45b5ec6b5   Andrew Buss   Fixed description...
203
  \begin{description}
de8099363   Laura Hawkins   half of the desig...
204
  \item[Description]{The User shall be able to add a class and access the
9bdef2907   Andrew Buss   Converted design ...
205
  flashcards associated with that class.}
de8099363   Laura Hawkins   half of the desig...
206
207
  \item[Desired Outcome]{The class shall be connected to the student's account
  and the User shall have the ability to read and publish flashcards
9bdef2907   Andrew Buss   Converted design ...
208
  for this class.}
45b5ec6b5   Andrew Buss   Fixed description...
209
  \\
de8099363   Laura Hawkins   half of the desig...
210
211
  \item[User Goals]{The User wants to publish flashcards for this class, and
  read the flashcards for this class that are published by other users.}
9bdef2907   Andrew Buss   Converted design ...
212

45b5ec6b5   Andrew Buss   Fixed description...
213
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
214

45b5ec6b5   Andrew Buss   Fixed description...
215
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
216
  Login}
45b5ec6b5   Andrew Buss   Fixed description...
217
218
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
219

de8099363   Laura Hawkins   half of the desig...
220
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
221
222
223
224
225
226
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
227
    {The User has registered an account.}
9bdef2907   Andrew Buss   Converted design ...
228
  \item
de8099363   Laura Hawkins   half of the desig...
229
    {The User has successfully logged in to the application.}
9bdef2907   Andrew Buss   Converted design ...
230
231
232
233
234
235
236
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
237
238
    {The User can view the flashcards being published for the class and
    add them to their deck.}
9bdef2907   Andrew Buss   Converted design ...
239
  \item
de8099363   Laura Hawkins   half of the desig...
240
    {The User can publish flashcards to be viewed and added by other users
9bdef2907   Andrew Buss   Converted design ...
241
242
    in the same class.}
  \end{itemize}
de8099363   Laura Hawkins   half of the desig...
243
  \item[Trigger]{The User wants to make flashcards and view flashcards for a class.}
9bdef2907   Andrew Buss   Converted design ...
244

45b5ec6b5   Andrew Buss   Fixed description...
245
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
246
247
248
249
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
250
    {The User shall click "Add a Class" from the drop down menu in the upper left hand corner.}
4d2ee9e3e   Chung Wang   A3 change. ( not...
251
  \item
de8099363   Laura Hawkins   half of the desig...
252
    {The frontend shall navigate to the new page described by addclass.html.}
9bdef2907   Andrew Buss   Converted design ...
253
  \item
de8099363   Laura Hawkins   half of the desig...
254
    {The User shall begin to type the class department code, course title, course number, or instructor in the text box.}
9bdef2907   Andrew Buss   Converted design ...
255
  \item
de8099363   Laura Hawkins   half of the desig...
256
    {The frontend in ClassAddController.js shall send a get request to the backend at api/sections/search/.}
9bdef2907   Andrew Buss   Converted design ...
257
  \item
de8099363   Laura Hawkins   half of the desig...
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
    {The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.}
  \item
    {The frontend shall show the classes that the backend has found.}
  \item
    {The User shall select from the classes the one that they want to add.}
  \item
    {The frontend shall enable the 'Add Class' button.}
  \item
    {The User shall click 'Add Class' button to the right of the text box.}
  \item
    {The frontend shall send a post request to api/sections/.}
  \item
    {The backend shall in views.py in function enroll shall call the method enroll in models.py.}
  \item
    {The backend in models.py in function enroll shall add the class to the User's sections.}
  \item
    {The frontend shall redirect the User to the class's Live Feed using the ClassAddController.js.}
  \item
    {The frontend shall present the live feed for the class by using feed.html and FeedController.js.}
9bdef2907   Andrew Buss   Converted design ...
277

de8099363   Laura Hawkins   half of the desig...
278
279
280
  \end{enumerate}
  
  \item[Alternate Workflow: User is whitelisted.\\]
9bdef2907   Andrew Buss   Converted design ...
281
282
283
  \begin{enumerate}
  \setcounter{enumi}{3}
  \itemsep1pt\parskip0pt\parsep0pt
de8099363   Laura Hawkins   half of the desig...
284
285
286
  \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
  \item
    {The User shall select their desired class, which has a whitelist, by clicking on ``Add Class''.}
9bdef2907   Andrew Buss   Converted design ...
287
  \item
de8099363   Laura Hawkins   half of the desig...
288
289
    {The frontend shall submit a POST request to /api/me/sections with
    the course ID that the User typed. }
9bdef2907   Andrew Buss   Converted design ...
290
  \item
de8099363   Laura Hawkins   half of the desig...
291
292
    {The backend shall check if there is a whitelist for the class that the 
    User has selected in models.py at function is\_whitelisted.}
9bdef2907   Andrew Buss   Converted design ...
293
  \item
de8099363   Laura Hawkins   half of the desig...
294
295
    {The backend shall check if the user is on the whitelist in models.py 
    in function is\_user\_on\_whitelist.}
9bdef2907   Andrew Buss   Converted design ...
296
  \item
de8099363   Laura Hawkins   half of the desig...
297
    {The backend shall add the User to the class following steps above.}
9bdef2907   Andrew Buss   Converted design ...
298
  \item
de8099363   Laura Hawkins   half of the desig...
299
    {The frontend shall redirect the User to the class's live feed followed the last step in the Workflow above.}
9bdef2907   Andrew Buss   Converted design ...
300
  \end{enumerate}
4d2ee9e3e   Chung Wang   A3 change. ( not...
301
302
303
  
  \item[Alternate Workflow: User is not whitelisted.]
  \begin{enumerate}
de2420793   Chung Wang   Testing numbers
304
  \setcounter{enumi}{7}
4d2ee9e3e   Chung Wang   A3 change. ( not...
305
  \itemsep1pt\parskip0pt\parsep0pt
de8099363   Laura Hawkins   half of the desig...
306
  \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
4d2ee9e3e   Chung Wang   A3 change. ( not...
307
  \item
de8099363   Laura Hawkins   half of the desig...
308
    {The backend shall will check that the user is in the whitelist in models.py.}
2ea9c20eb   Melody   Edited 'Study Deck'
309
  \item
de8099363   Laura Hawkins   half of the desig...
310
    {The frontend shall display that the class is whitelisted and the Add Class button will not be enabled.}
2ea9c20eb   Melody   Edited 'Study Deck'
311
  \end{enumerate}
4d2ee9e3e   Chung Wang   A3 change. ( not...
312

9bdef2907   Andrew Buss   Converted design ...
313
314
315
316
317
318
319
  \end{description}
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
320
  \subsection{[A4] Drop a Class}
9bdef2907   Andrew Buss   Converted design ...
321
322
  
  \begin{description}
de8099363   Laura Hawkins   half of the desig...
323
  \item[Description]{The User can remove themselves from a course he/she is
9bdef2907   Andrew Buss   Converted design ...
324
  registered to}
de8099363   Laura Hawkins   half of the desig...
325
  \item[Desired Outcome]{The User has dropped the class and no longer need
9bdef2907   Andrew Buss   Converted design ...
326
327
  access to the flashcards for said class. This means they can no longer
  see the flashcards associated to the class that they dropped }
45b5ec6b5   Andrew Buss   Fixed description...
328
  \\
de8099363   Laura Hawkins   half of the desig...
329
  \item[User Goals]{The User shall not have access to a class and the
9bdef2907   Andrew Buss   Converted design ...
330
  flashcards associated with that class. They will no longer see the class
de8099363   Laura Hawkins   half of the desig...
331
  listed in their drop down menu.}
9bdef2907   Andrew Buss   Converted design ...
332

45b5ec6b5   Andrew Buss   Fixed description...
333
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
334

45b5ec6b5   Andrew Buss   Fixed description...
335
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
336
  Login, {[}A3{]} Add a Class}
45b5ec6b5   Andrew Buss   Fixed description...
337
338
  \\
  \item[Priority Level]{ ``Should''}
9bdef2907   Andrew Buss   Converted design ...
339

de8099363   Laura Hawkins   half of the desig...
340
  \item[Status]{Implemented }
9bdef2907   Andrew Buss   Converted design ...
341

45b5ec6b5   Andrew Buss   Fixed description...
342
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
343
344
345
346
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
347
    {The User has a valid account.}
9bdef2907   Andrew Buss   Converted design ...
348
  \item
de8099363   Laura Hawkins   half of the desig...
349
    {The User is logged in.}
9bdef2907   Andrew Buss   Converted design ...
350
  \item
de8099363   Laura Hawkins   half of the desig...
351
352
353
    {The User has enrolled in at least one class.}
  \item
    {The User has navigated to the Settings page.}
9bdef2907   Andrew Buss   Converted design ...
354
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
355
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
356
357
358
359
360
361
362
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall no longer have access to dropped class, or associated
    flashcards}
  \end{itemize}
de8099363   Laura Hawkins   half of the desig...
363
  \item[Trigger]{User no longer wants to see flashcards from that class.}
9bdef2907   Andrew Buss   Converted design ...
364

45b5ec6b5   Andrew Buss   Fixed description...
365
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
366
367
368
369
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
370
    {The User shall click `Drop' button to the right of the class they wish to drop.}
9bdef2907   Andrew Buss   Converted design ...
371
  \item
de8099363   Laura Hawkins   half of the desig...
372
    {The frontend shall submit a DELETE request to
ca345eb7e   Andrew Buss   Restructured Chan...
373
    /api/me/sections/\textless{}section ID number\textgreater{}.}
9bdef2907   Andrew Buss   Converted design ...
374
  \item
de8099363   Laura Hawkins   half of the desig...
375
    {The backend shall check that the User is enrolled in the section in models.py in function drop.}
9bdef2907   Andrew Buss   Converted design ...
376
  \item
de8099363   Laura Hawkins   half of the desig...
377
    {The server shall remove the selected class from a user's list of section in models.py in function drop. }
9bdef2907   Andrew Buss   Converted design ...
378
  \item
de8099363   Laura Hawkins   half of the desig...
379
    {The frontend shall remove the class from the list in setting and show toast reading 'Dropped'.}
9bdef2907   Andrew Buss   Converted design ...
380
381
382
383
384
385
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
386
  \subsection{[A5] Password change}
9bdef2907   Andrew Buss   Converted design ...
387
388
  
  \begin{description}
de8099363   Laura Hawkins   half of the desig...
389
390
  \item[Description]{The User shall be able to change the password for their
  account in the account settings. }
9bdef2907   Andrew Buss   Converted design ...
391

de8099363   Laura Hawkins   half of the desig...
392
  \item[Desired Outcome]{The User's password shall be changed and the User
9bdef2907   Andrew Buss   Converted design ...
393
  shall be able to log in with the new password in the future}
45b5ec6b5   Andrew Buss   Fixed description...
394
  \\\\
de8099363   Laura Hawkins   half of the desig...
395
  \item[User Goals]{The User wants to use a different password in the future}
9bdef2907   Andrew Buss   Converted design ...
396

45b5ec6b5   Andrew Buss   Fixed description...
397
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
398

45b5ec6b5   Andrew Buss   Fixed description...
399
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
400
  Login}
45b5ec6b5   Andrew Buss   Fixed description...
401
  \\
de8099363   Laura Hawkins   half of the desig...
402
  \item[Details]{The User provides their current password and a new password
9bdef2907   Andrew Buss   Converted design ...
403
404
  in a form. If the current password is correct, the system updates their
  password to the requested new password.}
45b5ec6b5   Andrew Buss   Fixed description...
405
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
406

de8099363   Laura Hawkins   half of the desig...
407
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
408
409
410
411
412
413
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
414
    {The User has registered an account.}
9bdef2907   Andrew Buss   Converted design ...
415
  \item
de8099363   Laura Hawkins   half of the desig...
416
    {The User has logged in.}
9bdef2907   Andrew Buss   Converted design ...
417
  \item
de8099363   Laura Hawkins   half of the desig...
418
419
420
    {The User knows their current password.}
  \item
    {The User has navigated to the Settings page.}
9bdef2907   Andrew Buss   Converted design ...
421
422
423
424
425
426
427
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
428
    {The User's password is changed}
9bdef2907   Andrew Buss   Converted design ...
429
  \item
de8099363   Laura Hawkins   half of the desig...
430
    {The User can log in with the new password}
9bdef2907   Andrew Buss   Converted design ...
431
  \end{itemize}
de8099363   Laura Hawkins   half of the desig...
432
  \item[Trigger]{The User wants to change their password.}
9bdef2907   Andrew Buss   Converted design ...
433

ca345eb7e   Andrew Buss   Restructured Chan...
434
435
436
437
438
439
440
441
442
443
444
445
446
  \item[Error Handling] 
  \begin{description}
  \item[\small Missing Fields] \begin{itemize}
  \item The client shall enforce required fields
  \item The server will return an HTTP Bad Request error to the client.
  \end{itemize}
  \item[\small Incorrect Old Password] \begin{itemize}
  \item The server will return an HTTP Forbidden error to the client.
  \end{itemize}
  \item[\small Blank New Password] \begin{itemize}
  \item The server will return an HTTP Bad Request error to the client.
  \end{itemize}
  \end{description}
45b5ec6b5   Andrew Buss   Fixed description...
447
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
448
449
450
451
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
452
453
    {The frontend shall render a form that requires the user to enter their
    old password and new password from settings.html}
9bdef2907   Andrew Buss   Converted design ...
454
  \item
de8099363   Laura Hawkins   half of the desig...
455
456
    {The User shall type in their current password, the desired new
    password, and retype the desired new password to confirm.}
9bdef2907   Andrew Buss   Converted design ...
457
  \item
de8099363   Laura Hawkins   half of the desig...
458
    {The frontend shall submit the data to the server by sending a PATCH
ca345eb7e   Andrew Buss   Restructured Chan...
459
    request to /api/me containing ``old\_password'' and
de8099363   Laura Hawkins   half of the desig...
460
    ``new\_password'' values in SettingsController.js.}
ca345eb7e   Andrew Buss   Restructured Chan...
461
    \item (The )
9bdef2907   Andrew Buss   Converted design ...
462
  \item
de8099363   Laura Hawkins   half of the desig...
463
464
    {The backend shall check the user's current password in views.py in function patch under UserDetail.}
  \item  The backend shall update the user's current password in views.py in function patch under UserDetail.
9bdef2907   Andrew Buss   Converted design ...
465
  \item
de8099363   Laura Hawkins   half of the desig...
466
    {The frontend shall present a toast reading "Password successfully changed" and redirect the User to the Add a Class page.}
9bdef2907   Andrew Buss   Converted design ...
467
468
469
470
471
472
473
474
  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
475
  \subsection{[A6] Password reset}
9bdef2907   Andrew Buss   Converted design ...
476
477
  
  \begin{description}
de8099363   Laura Hawkins   half of the desig...
478
479
  \item[Description]{The User shall be able to reset their password without
  being logged in.}
9bdef2907   Andrew Buss   Converted design ...
480

de8099363   Laura Hawkins   half of the desig...
481
482
  \item[Desired Outcome]{The User's password shall be changed to one that
  they remember.}
45b5ec6b5   Andrew Buss   Fixed description...
483
  \\
de8099363   Laura Hawkins   half of the desig...
484
  \item[User Goals]{The User will be able to log into the site with a new password.}
9bdef2907   Andrew Buss   Converted design ...
485

45b5ec6b5   Andrew Buss   Fixed description...
486
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
487

45b5ec6b5   Andrew Buss   Fixed description...
488
489
490
  \item[Dependency Use Cases]{{[}A1{]} User Registration}
  \\
  \item[Details]{The user provides their email in a password reset form. If
9bdef2907   Andrew Buss   Converted design ...
491
492
493
494
495
496
497
  the address is valid, the site sends a password reset link with a random
  token to that address. If the address is invalid, the site does not send
  a link. For security reasons, we do not reveal to the user whether the
  email address was valid, and we expire the link after 24 hours. When a
  user visits the link emailed to them, they are able to specify a new
  password in a form. When they submit the form, their password is updated
  if the token is correct. }
45b5ec6b5   Andrew Buss   Fixed description...
498
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
499

de8099363   Laura Hawkins   half of the desig...
500
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
501
502
503
504
505
506
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
507
    {The User has created an account before.}
9bdef2907   Andrew Buss   Converted design ...
508
  \item
de8099363   Laura Hawkins   half of the desig...
509
510
511
    {The User knows the email address attached to their account for our application.}
  \item 
    {The User can log into their email account.}
9bdef2907   Andrew Buss   Converted design ...
512
513
514
515
516
517
518
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
519
    {The User's password is changed.}
9bdef2907   Andrew Buss   Converted design ...
520
  \item
de8099363   Laura Hawkins   half of the desig...
521
    {The User can log in with the new password.}
9bdef2907   Andrew Buss   Converted design ...
522
  \end{itemize}
de8099363   Laura Hawkins   half of the desig...
523
524
  \item[Trigger]{The User wants to log into the site but does not know their password.}
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
525
526
527
528
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
529
  {The User clicks ``Forgot Password'' text on the login page}
9bdef2907   Andrew Buss   Converted design ...
530
  \item
de8099363   Laura Hawkins   half of the desig...
531
    {The frontend shall render the password reset page from the template requestpasswordreset.html.}
9bdef2907   Andrew Buss   Converted design ...
532
  \item
de8099363   Laura Hawkins   half of the desig...
533
    {The User shall type in their email address for their account and click the "Reset" button.}
9bdef2907   Andrew Buss   Converted design ...
534
  \item
de8099363   Laura Hawkins   half of the desig...
535
    {The frontend shall send a POST request to /api/request\_password\_reset/ from RequestResetController.js.}
9bdef2907   Andrew Buss   Converted design ...
536
  \item
de8099363   Laura Hawkins   half of the desig...
537
538
    {The backend shall check if an account exists with the email entered by
    the User in views.py in function request\_password\_reset.}
9bdef2907   Andrew Buss   Converted design ...
539
  \item
de8099363   Laura Hawkins   half of the desig...
540
541
    {The backend shal send an email to the User with a link to the password reset page in models.py in function
    request\_password\_reset.}
9bdef2907   Andrew Buss   Converted design ...
542
  \item
de8099363   Laura Hawkins   half of the desig...
543
    {The User will navigate to their email account, open the email, and click the link.}
9bdef2907   Andrew Buss   Converted design ...
544
  \item
de8099363   Laura Hawkins   half of the desig...
545
546
547
548
549
550
    {The frontend shall render the password reset page from the template resetpassword.html.}
  \item 
    {The User shall type in their new password and re-type it to confirm it.}
  \item 
    {The frontend shall check if the new password is long enough and if the confirmed password is the same as
    the new password in ResetPasswordController.js.}
9bdef2907   Andrew Buss   Converted design ...
551
  \item
de8099363   Laura Hawkins   half of the desig...
552
    {The frontend shall send a POST request to /api/reset\_password from ResetPasswordController.js.}
9bdef2907   Andrew Buss   Converted design ...
553
  \item
de8099363   Laura Hawkins   half of the desig...
554
    {The backend shall change the user's password in views.py in function reset\_password.}
9bdef2907   Andrew Buss   Converted design ...
555
  \item
de8099363   Laura Hawkins   half of the desig...
556
    {The frontend shall redirect the User to the login page. }
9bdef2907   Andrew Buss   Converted design ...
557
  \item
de8099363   Laura Hawkins   half of the desig...
558
    {The User shall use their new password to login to the application.}
9bdef2907   Andrew Buss   Converted design ...
559
560
561
562
563
564
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
565
  \subsection{[A7] Limit Student Access to Courses}
9bdef2907   Andrew Buss   Converted design ...
566
567
568
569
570
  
  \begin{description}
  \item[Description]{The instructor shall be able to limit access to the
  courses that he is in charge of by whitelisting only those students that
  are actually in the class.}
45b5ec6b5   Andrew Buss   Fixed description...
571
  \item[Desired Outcome]{The class will have limited access and only those
9bdef2907   Andrew Buss   Converted design ...
572
  users who are whitelisted may enroll in the class.}
45b5ec6b5   Andrew Buss   Fixed description...
573
  \\
9bdef2907   Andrew Buss   Converted design ...
574
575
576
577
578
  \item[User Goals]{The instructor wants to limit access to his class so only
  the students who are actually in his class participate, and nobody
  else.}
  
  {Primary Actor: }{User (instructor)}
45b5ec6b5   Andrew Buss   Fixed description...
579
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
580
  Login}
45b5ec6b5   Andrew Buss   Fixed description...
581
582
  \\
  \item[Priority Level]{``Should''}
9bdef2907   Andrew Buss   Converted design ...
583

de8099363   Laura Hawkins   half of the desig...
584
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
585

45b5ec6b5   Andrew Buss   Fixed description...
586
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
587
588
589
590
591
592
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has valid instructor's account}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
593
  \item[Post-conditions]
9bdef2907   Andrew Buss   Converted design ...
594
595
596
597
598
599
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Only those users who were whitelisted may add the class.}
  \end{itemize}
de8099363   Laura Hawkins   half of the desig...
600
601
  \item[Trigger]{The course instructor wants to limit the students who
  can add his class on our application.}
9bdef2907   Andrew Buss   Converted design ...
602

45b5ec6b5   Andrew Buss   Fixed description...
603
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
604
605
606
607
608
609
610
611
612
613
614
615
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The instructor emails the administrators from his UCSD email address
    and requests to limit access to his course. He provides a list of
    emails of the students that are to be whitelisted.}
  \item
    {The administrators visit a custom admin page, select the course, and
    paste the list of emails. They submit the page directly (no separate
    frontend here) to the server.}
  \item
de8099363   Laura Hawkins   half of the desig...
616
    {The backend shall create a WhitelistedAddress for each provided email,
9bdef2907   Andrew Buss   Converted design ...
617
618
    attaching it to the section taught by the instructor.}
  \item
de8099363   Laura Hawkins   half of the desig...
619
    {The backend shall add any existing users whose email addresses appear
9bdef2907   Andrew Buss   Converted design ...
620
621
622
623
624
    in the whitelist to the class. }
  \end{enumerate}
  \end{description}
  
  ewpage
770e764f2   Melody   Might have possib...
625
  \subsection{[A8] User Logout}
9bdef2907   Andrew Buss   Converted design ...
626
627
  
  \begin{description}
de8099363   Laura Hawkins   half of the desig...
628
  \item[Description]{The User shall be able to log out of his/her account on
9bdef2907   Andrew Buss   Converted design ...
629
  the site.}
de8099363   Laura Hawkins   half of the desig...
630
  \item[Desired Outcome]{The User's information and data will no longer be
9bdef2907   Andrew Buss   Converted design ...
631
  accessible after logging out. }
45b5ec6b5   Andrew Buss   Fixed description...
632
  \\
de8099363   Laura Hawkins   half of the desig...
633
  \item[User Goals]{The User is done with his/her session of using the
9bdef2907   Andrew Buss   Converted design ...
634
635
  website, and wants to make sure others cannot access the data in his/her
  account.}
45b5ec6b5   Andrew Buss   Fixed description...
636
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
637

45b5ec6b5   Andrew Buss   Fixed description...
638
639
640
  \item[Dependency Use Cases] None
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
641
642
  
  \item[Status]{Implemented}
45b5ec6b5   Andrew Buss   Fixed description...
643
  \item[Pre-conditions]{The user is logged into their account}
9bdef2907   Andrew Buss   Converted design ...
644

45b5ec6b5   Andrew Buss   Fixed description...
645
  \item[Post-conditions]{}{The user's data can no longer be accessed.}
9bdef2907   Andrew Buss   Converted design ...
646

de8099363   Laura Hawkins   half of the desig...
647
  \item[Trigger]{The User no longer wants to be logged into the application.}
9bdef2907   Andrew Buss   Converted design ...
648
649
650
651
652
653
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
654
    {The User clicks the 'Logout' button in the upper right hand corner.}
9bdef2907   Andrew Buss   Converted design ...
655
  \item
de8099363   Laura Hawkins   half of the desig...
656
657
658
    {The backend shall log the User out using the Django logout feature.}
  \item
    {The frontend renders the application login page using login.html.}
9bdef2907   Andrew Buss   Converted design ...
659
  \end{enumerate}
45b5ec6b5   Andrew Buss   Fixed description...
660
  \end{description}
9bdef2907   Andrew Buss   Converted design ...
661
662
663
  
  
  ewpage
770e764f2   Melody   Might have possib...
664
  \subsection{[A9] Contact Admin}
9bdef2907   Andrew Buss   Converted design ...
665
666
  
  \begin{description}
de8099363   Laura Hawkins   half of the desig...
667
  \item[Description]{The User shall be able to contact the admin.}
9bdef2907   Andrew Buss   Converted design ...
668

de8099363   Laura Hawkins   half of the desig...
669
  \item[Desired Outcome]{The User shall send a message to the admin; the
9bdef2907   Andrew Buss   Converted design ...
670
  admin shall receive the message.}
de8099363   Laura Hawkins   half of the desig...
671
  {User Goals:}{The User sends a message to the admin.}
9bdef2907   Andrew Buss   Converted design ...
672

45b5ec6b5   Andrew Buss   Fixed description...
673
  \item[Primary Actor]{User}
9bdef2907   Andrew Buss   Converted design ...
674

45b5ec6b5   Andrew Buss   Fixed description...
675
676
677
  \item[Dependency Use Cases]{None}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
678

de8099363   Laura Hawkins   half of the desig...
679
  \item[Status]{Implemented}
9bdef2907   Andrew Buss   Converted design ...
680

de8099363   Laura Hawkins   half of the desig...
681
  \item[Pre-conditions]{The User has an account registered and is logged in.}
9bdef2907   Andrew Buss   Converted design ...
682

45b5ec6b5   Andrew Buss   Fixed description...
683
  \item[Post-conditions]{The admin receives the user's message.}
9bdef2907   Andrew Buss   Converted design ...
684

de8099363   Laura Hawkins   half of the desig...
685
686
  \item[Trigger]{The User wants to contact the adiminstators of the site with
  bug reports, questions, or praise. }
9bdef2907   Andrew Buss   Converted design ...
687
688
689
690
691
692
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
de8099363   Laura Hawkins   half of the desig...
693
694
695
696
697
698
699
700
701
702
703
     {The User shall click the '?' button that presents a toast reading "Help" when the User hovers over it.}
  \item
     {The frontend shall render the page using the help.html template.}
  \item 
     {The User shall scroll to the bottom of the page.}
  \item 
     {The User shall click the text reading "Send Us an Email!"}
  \item
     {The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.}
  \item
     {The User shall see our email address in the recipients text box.}
9bdef2907   Andrew Buss   Converted design ...
704
705
706
707
708
709
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
b816d0356   Andrew Buss   Added sections
710
  \section{Flashcards}
770e764f2   Melody   Might have possib...
711
  \subsection{[F1] Push Flashcard}
9bdef2907   Andrew Buss   Converted design ...
712
713
714
715
  
  \begin{description}
  \item[Description]{The user shall be able to create a flashcard with their
  input. }
45b5ec6b5   Andrew Buss   Fixed description...
716
  \item[Desired Outcome]{The user shall have the flashcard added to their own
9bdef2907   Andrew Buss   Converted design ...
717
  deck and the Live Feed. }
45b5ec6b5   Andrew Buss   Fixed description...
718
  \\
9bdef2907   Andrew Buss   Converted design ...
719
720
  \item[User Goals]{The user will see their flashcard in their deck and the
  flashcard will be shared with others. }
45b5ec6b5   Andrew Buss   Fixed description...
721
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
722
  Login, {[}A3{]} Add a Class}
45b5ec6b5   Andrew Buss   Fixed description...
723
724
  \\
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User has an account }
  \item
    {The User has added at least one class}
  \item
    {The User is on the class' page}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User has flashcard added to their deck}
  \item
    {The Flashcard is shown in the Live Feed}
  \item
    {Other users can add this flashcard to their decks}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
747
  \item[Trigger]{}
9bdef2907   Andrew Buss   Converted design ...
748
749
750
751
752
753
754
755
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User has clicked on the button ``Make New Flashcard''.}
  \item
    {The Server receives a POST request containing the flashcard data.}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
756
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User is at the live feed for the class.}
  \item
    {The User shall click on the button}{Push
    Flashcard}
  \item
    {The
    }{Client}{shall
    present a dialog box for inputting the flashcard text to the User.}
  \item
    {The User shall input the flashcard text.}
  \item
    {Optionally, the User shall mark keywords in the flashcard text.}
  \item
    {If the User creates this flashcard outside of the lecture time, he
    will get the option to change the material date.}
  \item
    {The User shall click on the `Submit' button to submit the flashcard
    text, blanks, and material date, in JSON form as a POST request.}
  \item
    {The Server shall obtain the flashcard information by deserializing
    the JSON in the POST request.}
  \item
    {The Server shall create a new record for this flashcard in the
    Flashcards table in the database.}
  \item
    {The Server shall publish the newly created card to the live feed of
    the class.}
  \end{enumerate}
  \end{description}
  {Alternative Workflow:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User shall view a flashcard that he/she did not create}
  \item
    {The User shall click ``Edit''}
  \item
    {The client shall present a dialog box for editing the existing
    flashcard text}
  \item
    {The User shall make edits}
  \item
    {The User shall click ``save''}
  \item
    {The client shall send a POST request}
  \item
    {The server shall remove the original card from user's deck}
  \item
    {The Server shall obtain the flashcard information by deserializing
    the JSON in the POST request.}
  \item
    {The Server shall create a new record for this flashcard in the
    Flashcards table in the database.}
  \item
    {The Server shall publish the newly created card to the live feed of
    the class.}
  \end{enumerate}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
824
  \subsection{[F2] Edit Flashcard}
9bdef2907   Andrew Buss   Converted design ...
825
826
827
828
  
  \begin{description}
  \item[Description]{The user shall be able to edit the text on their own
  flashcard }
45b5ec6b5   Andrew Buss   Fixed description...
829
830
  \item[Desired Outcome]{Flashcard is edited and saved appropriately}
  \\
9bdef2907   Andrew Buss   Converted design ...
831
  \item[User Goals]{To be able to change text on a flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
832
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
  Flashcard}
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Flashcard is created}
  \item
    {Flashcard in user's deck}
  \item
    {Flashcard is viewable}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Flashcard is edited}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
855
  \item[Trigger]{User has clicked ``Edit'' button when viewing a specific
9bdef2907   Andrew Buss   Converted design ...
856
  flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
857
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The user shall view their deck}
  \item
    {The client shall present user with a grid view of cards in
    chronological creation order}
  \item
    {The user shall select a flashcard and click `Edit'}
  \item
    {The client shall produce an editable dialog box containing flashcard
    text}
  \item
    {The user shall make desired changes}
  \item
    {The user shall click `Save'}
  \item
    {The client shall generate a POST request for a new flashcard and send
    it to the server}
  \item
    {If the user changed only the blanks of the cards, the server shall
    create a new FlashcardMask object and update the appropriate
    UserFlashcard object with a reference to it.}
  \item
    {If the user changed the text of the card, the server will instead:}
  \end{enumerate}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {create a new flashcard for the section}
  \item
    {push it to the feed}
  \item
    {add it to the user's deck}
  \item
    {hide the old card from the user}
  \item
    {and return the new card to the user}
  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
906
  \subsection{[F3] Pull Flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
907
908
  \begin{description}
  \item[Description]{The User shall be able to add flash cards to their own
9bdef2907   Andrew Buss   Converted design ...
909
  deck from the Live Feed. }
45b5ec6b5   Andrew Buss   Fixed description...
910
  \item[Desired Outcome]{The User shall have the flashcard added to their own
9bdef2907   Andrew Buss   Converted design ...
911
  deck }
45b5ec6b5   Andrew Buss   Fixed description...
912
  \\
9bdef2907   Andrew Buss   Converted design ...
913
  \item[User Goals]{The user will be able to review that flashcard. }
45b5ec6b5   Andrew Buss   Fixed description...
914
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
915

45b5ec6b5   Andrew Buss   Fixed description...
916
917
918
919
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard}
  \\
  \item[Priority Level]{``Must'' }
9bdef2907   Andrew Buss   Converted design ...
920
921
  
  \item[Status]{Not Implemented}
45b5ec6b5   Andrew Buss   Fixed description...
922
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Flashcard has been created }
  \item
    {That flashcard is in the Live Feed}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall have that flashcard added to their deck}
  \item
    {User can review this flashcard later}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
941
  \item[Trigger]{User has clicked on the flashcard in the Live Feed.}
9bdef2907   Andrew Buss   Converted design ...
942

45b5ec6b5   Andrew Buss   Fixed description...
943
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User is in the Live Feed.}
  \item
    {User shall click on the ``Pull Flashcard'' button on a Flashcard in
    the Feed.}
  \item
    {The Client shall make the pulled Flashcard disappear from the Live
    Feed}
  \item
    {The Client shall make the pulled Flashcard appear in the User's Deck
    on the sidebar.}
  \item
    {The Client shall submit a POST request to
    /api/flashcards/\textless{}flashcard id\textgreater{}/pull}
  \item
    {The server shall create a UserFlashcard object to represent that the
    user's deck contains the card.}
  \item
    {The server shall notify connected clients about the new card rating,
    if any}
  \item
    {Connected clients will take the new rating into account when next
    rearranging the feed.}
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
976
  \subsection{[F4] Flag Inappropriate Cards}
9bdef2907   Andrew Buss   Converted design ...
977
978
979
  
  \begin{description}
  \item[Description]{Cards may be flagged indicating inappropriate content}
45b5ec6b5   Andrew Buss   Fixed description...
980
  \item[Desired Outcome]{The flashcard's inappropriateness variable is
9bdef2907   Andrew Buss   Converted design ...
981
  adjusted}
45b5ec6b5   Andrew Buss   Fixed description...
982
  \\
9bdef2907   Andrew Buss   Converted design ...
983
984
  \item[User Goals]{To note if a card should not belong in the class and
  should not be displayed in the feed}
45b5ec6b5   Andrew Buss   Fixed description...
985
  \item[Primary Actor]{User (Student)}
9bdef2907   Andrew Buss   Converted design ...
986

45b5ec6b5   Andrew Buss   Fixed description...
987
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
988
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
989
990
  \\
  \item[Priority Level]{``Should''}
9bdef2907   Andrew Buss   Converted design ...
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
  
  \item[Status]{Unimplemented}
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User is enrolled in a class}
  \end{itemize}
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Flashcard is created}
  \item
    {Flashcard is viewable in feed}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Flashcard is hidden from user}
  \item
    {Flashcard internal variable is adjusted}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1019
  \item[Trigger]{User clicks flag on a specific flashcard}
9bdef2907   Andrew Buss   Converted design ...
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User is at a page of their classes.}
  \item
    {The User selects one of their classes to enter the Live Feed.}
  \item
    {The User is on the Live Feed for his/her class.}
  \item
    {The User shall identify an inappropriate card and flag the card.}
  \item
    {The User clicks the ``Flag as Inappropriate'' button on the flashcard
    that he/she wants to report}
  \item
    {The Client shall hide the card from the user}
  \item
    {The server shall create a FlashcardReport object}
  \end{enumerate}
  \end{description}
  {}
  
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1050
  \subsection{[F5] Filter Flashcards}
9bdef2907   Andrew Buss   Converted design ...
1051
1052
1053
  
  \begin{description}
  \item[Description]{The user is able to filter for flashcards by date}
45b5ec6b5   Andrew Buss   Fixed description...
1054
  \item[Desired Outcome]{The user shall see flashcards based on the filter
9bdef2907   Andrew Buss   Converted design ...
1055
  options}
45b5ec6b5   Andrew Buss   Fixed description...
1056
  {User Goals:}{The user can find what he/she is specifically looking
9bdef2907   Andrew Buss   Converted design ...
1057
  for}
45b5ec6b5   Andrew Buss   Fixed description...
1058
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1059

45b5ec6b5   Andrew Buss   Fixed description...
1060
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
1061
1062
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
  Flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
1063
1064
  \\
  \item[Priority Level]{''Should''}
9bdef2907   Andrew Buss   Converted design ...
1065

45b5ec6b5   Andrew Buss   Fixed description...
1066
  \item[Status]{Not}{}{Implemented }
9bdef2907   Andrew Buss   Converted design ...
1067

45b5ec6b5   Andrew Buss   Fixed description...
1068
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
1069
1070
1071
1072
1073
1074
1075
1076
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has registered for the course }
  \item
    {Flashcards exist in the course}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1077
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
1078
1079
1080
1081
1082
1083
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User only sees specific flashcards}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1084
  \item[Trigger]{User has selected advanced options from menu}
9bdef2907   Andrew Buss   Converted design ...
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User chooses one of their classes.}
  \item
    {The User presses the class they want to view.}
  \item
    {The Client displays the Live Feed.}
  \item
    {The User is at the Live Feed.}
  \item
    {The User wants to filter the cards on the Live Feed.}
  \item
    {The User shall select what filter option they want from a drop down
    menu.}
  \item
    {The Client shall display only relevant flashcards.}
  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1113
  \subsection{[F6] Blank Out Words in Flashcard}
9bdef2907   Andrew Buss   Converted design ...
1114
1115
1116
1117
  
  \begin{description}
  \item[Description]{The User shall be able to blank out keywords in any
  flashcard in his deck. }
45b5ec6b5   Andrew Buss   Fixed description...
1118
  \item[Desired Outcome]{The blanked out words in the flashcard notify the
9bdef2907   Andrew Buss   Converted design ...
1119
  System that they are keywords. }
45b5ec6b5   Andrew Buss   Fixed description...
1120
  \\
9bdef2907   Andrew Buss   Converted design ...
1121
1122
1123
1124
1125
  \item[User Goals]{The User shall mark some words as keywords so the System
  may later quiz theirself by blanking out the keywords and having the
  User guess what they are.}
  
  {Primary Actor: }{User (student)}
45b5ec6b5   Andrew Buss   Fixed description...
1126
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
1127
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
1128
1129
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1130
1131
  
  \item[Status]{Not implemented.}
45b5ec6b5   Andrew Buss   Fixed description...
1132
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User has the flashcard he wishes to blank out words from in his
    deck.}
  \item
    {The User shall (be on the class page and) view deck}
  \end{itemize}
  
  {Post-conditions: }
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The blanked out words in the flashcard are marked as keywords.}
  \item
    {The System shall blank out the keywords and let the User guess what
    they are when it presents the flashcard to the User for reviewing.}
  \end{itemize}
  
  \item[Trigger]{The User clicks on a flashcard.}
45b5ec6b5   Andrew Buss   Fixed description...
1155
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The Client shall a show deck to user}
  \item
    {The User shall click on the flashcard in his deck that he wants to
    blank out words from}
  \item
    {The client shall bring user to edit flashcard page/popup}
  \item
    {The User shall click on the words that he wishes to blank out}
  \item
    {The client shall specify a character range as blank}
  \item
    {The server shall mark those words by updating the Flashcard Mask for
    that flashcard. }
  \item
    {The User shall click on `Save' or the equivalent button to save the
    changes}
  \item
    {The server will save the blanked out words as keywords to the
    Flashcard Mask to review}
  \item
    {The client shall cover the keywords with whitespace to hide them from
    the User}
  \end{enumerate}
  
  {Alternative Workflows:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User shall (be on the class page and) click ``Make New
    Flashcard''}
  \item
    {The client shall present user with a new flashcard to fill in}
  \item
    {The User shall fill in the information}
  \item
    {The client shall ask if the user wants to specify blanks}
  \item
    {The System will save the blanked out words as keywords to the
    Flashcard Mask to review}
  \item
    {The client shall cover the keywords with whitespace to hide them from
    the User}
  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1211
  \subsection{[F7] Fix Flashcard}
9bdef2907   Andrew Buss   Converted design ...
1212
1213
1214
1215
  
  \begin{description}
  \item[Description]{The User shall be able to alter a flashcard he/she made
  originally and not have to make a new copy of it.}
45b5ec6b5   Andrew Buss   Fixed description...
1216
  \item[Desired Outcome]{The User shall alter one flashcard and that
9bdef2907   Andrew Buss   Converted design ...
1217
  alteration will be shown to all users of that flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
1218
  \\
9bdef2907   Andrew Buss   Converted design ...
1219
1220
  \item[User Goals]{The user shall make the flashcard say something different
  than it did originally.}
45b5ec6b5   Andrew Buss   Fixed description...
1221
  \item[Primary Actor]{User (student) }
9bdef2907   Andrew Buss   Converted design ...
1222

45b5ec6b5   Andrew Buss   Fixed description...
1223
  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
1224
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
1225
  \\
9bdef2907   Andrew Buss   Converted design ...
1226
1227
1228
  \item[Priority Level]{Must}
  
  \item[Status]{Not Implemented}
45b5ec6b5   Andrew Buss   Fixed description...
1229
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
1230
1231
1232
1233
1234
1235
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has created the flashcard}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1236
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
1237
1238
1239
1240
1241
1242
1243
1244
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The user shall see their alteration for that flashcard}
  \item
    {Other users will be notified of the alteration}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1245
  \item[Trigger]{User (creator of original card) has clicked on the button
9bdef2907   Andrew Buss   Converted design ...
1246
  ``Edit''}
45b5ec6b5   Andrew Buss   Fixed description...
1247
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall select one of the Flashcards they authored.}
  \item
    {User shall select ``Edit'' button on the flashcard.}
  \item
    {Client shall display an ``Edit Flashcard'' view.}
  \item
    {The Flashcard will display editable fields/areas.}
  \item
    {The User shall input any changes to the Flashcard.}
  \item
    {The User shall select the ``Done Editing'' button.}
  \item
    {The Client shall close the ``Edit Flashcard'' view.}
  \item
    {The server shall update the Flashcard's content.}
  \item
    {Client shall notify users with the Flashcard that the Flashcard has
    been edited, allowing the other users to keep or to discard the
    changes.}
  \end{enumerate}
  \end{description}
  {}
  
  {}
  
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1283
  \subsection{[F8] Hide cards from feed}
9bdef2907   Andrew Buss   Converted design ...
1284
1285
1286
  
  \begin{description}
  \item[Description]{The user shall be able to hide cards from feed}
45b5ec6b5   Andrew Buss   Fixed description...
1287
1288
  \item[Desired Outcome]{The card is no longer visible to the user}
  \\
9bdef2907   Andrew Buss   Converted design ...
1289
1290
1291
1292
  \item[User Goals]{The card has been looked at and should be hidden to
  reduce screen clutter}
  
  {Primary Actor: }{User (Student)}
45b5ec6b5   Andrew Buss   Fixed description...
1293
  \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
1294
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
45b5ec6b5   Andrew Buss   Fixed description...
1295
1296
  \\
  \item[Priority Level]{``Should''}
9bdef2907   Andrew Buss   Converted design ...
1297

45b5ec6b5   Andrew Buss   Fixed description...
1298
  {Status:}{Not implemented}
9bdef2907   Andrew Buss   Converted design ...
1299

45b5ec6b5   Andrew Buss   Fixed description...
1300
  \item[Pre-conditions]{Flashcard is created, flashcard is viewable by user}
9bdef2907   Andrew Buss   Converted design ...
1301

45b5ec6b5   Andrew Buss   Fixed description...
1302
  \item[Post-conditions]{Flashcard is not viewable by user}
9bdef2907   Andrew Buss   Converted design ...
1303

45b5ec6b5   Andrew Buss   Fixed description...
1304
  \item[Trigger]{Card is flagged; Card is noted to be hidden}
9bdef2907   Andrew Buss   Converted design ...
1305

45b5ec6b5   Andrew Buss   Fixed description...
1306
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User chooses a class from the dashboard.}
  \item
    {The Client shows the Live Feed for the selected class.}
  \item
    {The User sees a card they want to hide from the Live Feed.}
  \item
    {The User shall press a ``Hide Flashcard'' button on the card to be
    hidden.}
  \item
    {The Client shall hide the card of interest from the Live Feed, for
    only that User.}
  \end{enumerate}
  
  \end{description}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1330
  \subsection{[F9] View a Feed}
9bdef2907   Andrew Buss   Converted design ...
1331
1332
1333
1334
  
  \begin{description}
  \item[Description]{The user shall be able to view Live Feeds for different
  classes}
45b5ec6b5   Andrew Buss   Fixed description...
1335
  \item[Desired Outcome]{The system shall only show the user Live Feeds for
9bdef2907   Andrew Buss   Converted design ...
1336
  specific classes. }
45b5ec6b5   Andrew Buss   Fixed description...
1337
  \\
9bdef2907   Andrew Buss   Converted design ...
1338
  \item[User Goals]{The user will see only one Live Feed at a time. }
45b5ec6b5   Andrew Buss   Fixed description...
1339
  \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
9bdef2907   Andrew Buss   Converted design ...
1340
  Login, {[}A3{]} Add a Class}
45b5ec6b5   Andrew Buss   Fixed description...
1341
1342
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1343

45b5ec6b5   Andrew Buss   Fixed description...
1344
  {Status:}{Not implemented}
9bdef2907   Andrew Buss   Converted design ...
1345

45b5ec6b5   Andrew Buss   Fixed description...
1346
  \item[Pre-conditions]{User has added a class}
9bdef2907   Andrew Buss   Converted design ...
1347

45b5ec6b5   Andrew Buss   Fixed description...
1348
  \item[Post-conditions]{User shall see the Live Feed for that class}
9bdef2907   Andrew Buss   Converted design ...
1349

45b5ec6b5   Andrew Buss   Fixed description...
1350
  \item[Trigger]{User shall select a class}
9bdef2907   Andrew Buss   Converted design ...
1351

45b5ec6b5   Andrew Buss   Fixed description...
1352
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User logs into their account.}
  \item
    {The System verifies the User's credentials and saves their session.}
  \item
    {The User is at their dashboard.}
  \item
    {The Client shows the User's dashboard.}
  \item
    {The User selects a class from their dashboard.}
  \item
    {The Client displays the Live Feed for the class.}
  \end{enumerate}
  
  \end{description}
  
  ewpage
  
  {}
b816d0356   Andrew Buss   Added sections
1375
  \section{Decks}
770e764f2   Melody   Might have possib...
1376
  \subsection{[-D2-] Making a deck}
9bdef2907   Andrew Buss   Converted design ...
1377
1378
1379
1380
1381
  
  \begin{description}
  \item[Description]{Upon selecting the right course, the student has the
  power to make a deck by either selecting existing flashcard or adding a
  new flashcard.}
45b5ec6b5   Andrew Buss   Fixed description...
1382
1383
  \item[Desired Outcome]{The user can keep track of cards that s/he wants.}
  \\
9bdef2907   Andrew Buss   Converted design ...
1384
  \item[User Goals]{The user has a personal deck ready for review later.}
45b5ec6b5   Andrew Buss   Fixed description...
1385
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1386

45b5ec6b5   Andrew Buss   Fixed description...
1387
  \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
9bdef2907   Andrew Buss   Converted design ...
1388
  {[}F1{]}, Make a Flashcard {[}F3{]}}
45b5ec6b5   Andrew Buss   Fixed description...
1389
1390
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
  
  \item[Status]{In Progress}
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The user has an account with the application. }
  \item
    {The user has been added to the desired class.}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Desired cards are added to user's deck to the specific class }
  \item
    {User's deck is added to the database.}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1413
  \item[Trigger]{User has selected a card from the pool. User submitted a
9bdef2907   Andrew Buss   Converted design ...
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
  new flashcard after ``Make New Flashcard''.}
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User is at their dashboard.}
  \item
    {User selects the class of interest that they had no activity in yet.}
  \item
    {Client displays the Live Feed for the class.}
  \item
    {User presses ``Pull Flashcard'' button on a Flashcard that they want
    in their Deck.}
  \item
    {The server creates a Deck for the User for the Class of interest.}
  \item
    {The server adds the Flashcard to the User's Deck.}
  \item
    {The Client makes the Flashcard disappear from the Live Feed.}
  \item
    {The Client displays the Flashcard in the User's Deck in the sidebar.}
  \end{enumerate}
  
  {Alternate Workflow:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User is at their dashboard.}
  \item
    {User selects the class of interest that they had no activity in yet.}
  \item
    {Client displays the Live Feed for the class.}
  \item
    {The User adds a Flashcard into the Class.}
  \item
    {The server creates a Deck for the User for the Class of interest.}
  \item
    {The server adds the new Flashcard to the User's Deck.}
  \item
    {The Client makes the Flashcard disappear from the Live Feed.}
  \item
    {The Client displays the Flashcard in the User's Deck in the sidebar.}
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1465
  \subsection{[D1] Remove a card from a deck}
9bdef2907   Andrew Buss   Converted design ...
1466
1467
1468
  
  \begin{description}
  \item[Description]{The user can remove flashcards from their deck.}
45b5ec6b5   Andrew Buss   Fixed description...
1469
1470
  \item[Desired Outcome]{The user will not be notified about that card. }
  \\
9bdef2907   Andrew Buss   Converted design ...
1471
  \item[User Goals]{To only review cards that the user wants to review. }
45b5ec6b5   Andrew Buss   Fixed description...
1472
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1473

45b5ec6b5   Andrew Buss   Fixed description...
1474
  \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
9bdef2907   Andrew Buss   Converted design ...
1475
  {[}F1{]}, Make a Flashcard {[}F3{]}}
45b5ec6b5   Andrew Buss   Fixed description...
1476
1477
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
  
  \item[Status]{Unimplemented}
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The User has an account with the application}
  \item
    {The User is logged in}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Desired cards are hidden to the user.}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1498
  \item[Trigger]{User has selected a card to be hidden.}
9bdef2907   Andrew Buss   Converted design ...
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The Client shows the user the dashboard.}
  \item
    {The User shall select the appropriate class.}
  \item
    {The System checks if the class is in session.}
  \item
    {The User shall select deck view.}
  \item
    {The Client shall route the user to the deck view.}
  \item
    {The User clicks a flashcard's remove button.}
  \item
45b5ec6b5   Andrew Buss   Fixed description...
1517
    {The Client shall send a DELETE request to the server}{}{at
9bdef2907   Andrew Buss   Converted design ...
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
    /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
  \item
    {The Server removes the flashcard from the User's Deck.}
  \item
    {The Server updates the flashcard's position in the Live Feed.}
  \item
    {The Client updates the User's Deck.}
  \end{enumerate}
  
  {}
  
  {Alternate Workflow:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The Client shows the user the dashboard.}
  \item
    {The User shall select the appropriate class.}
  \item
45b5ec6b5   Andrew Buss   Fixed description...
1538
    {The System checks if the class is }{not}{in session.}
9bdef2907   Andrew Buss   Converted design ...
1539
1540
1541
1542
1543
  \item
    {The Client shall the user to the deck view.}
  \item
    {The User clicks a flashcard's remove button.}
  \item
45b5ec6b5   Andrew Buss   Fixed description...
1544
    {The Client shall send a DELETE request to the server}{}{at
9bdef2907   Andrew Buss   Converted design ...
1545
1546
1547
1548
1549
1550
1551
1552
1553
    /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
  \item
    {The Server removes the flashcard from the User's Deck.}
  \item
    {The Server updates the flashcard's position in the Live Feed.}
  \item
    {The Client updates the User's Deck.}
  \end{enumerate}
  \end{description}
9bdef2907   Andrew Buss   Converted design ...
1554

770e764f2   Melody   Might have possib...
1555
  \subsection{[-D2-] Shuffling deck}
9bdef2907   Andrew Buss   Converted design ...
1556
1557
1558
1559
  
  \begin{description}
  \item[Description]{User is able to shuffle his/her deck as a way to study
  the flashcards}
45b5ec6b5   Andrew Buss   Fixed description...
1560
  \item[Desired Outcome]{When taking a quiz, the user will notice that
9bdef2907   Andrew Buss   Converted design ...
1561
  flashcards appear in random order}
45b5ec6b5   Andrew Buss   Fixed description...
1562
  {User Goals:}{Improve quiz taking skills and knowledge consumption}
9bdef2907   Andrew Buss   Converted design ...
1563

45b5ec6b5   Andrew Buss   Fixed description...
1564
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1565

45b5ec6b5   Andrew Buss   Fixed description...
1566
1567
1568
  \item[Dependency Use Cases]{Deck has been created {[}D2{]}}
  \\
  \item[Priority Level]{}{''Won't''}
9bdef2907   Andrew Buss   Converted design ...
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
  
  \item[Status]{Implemented }
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User must have registered for course }
  \end{itemize}
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User must have added cards to deck}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1585
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
1586
1587
1588
1589
1590
1591
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User takes a quiz and notice the deck has been shuffled}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1592
  \item[Trigger]{User has clicked on the button ``SHUFFLE DECK''}
9bdef2907   Andrew Buss   Converted design ...
1593

45b5ec6b5   Andrew Buss   Fixed description...
1594
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User is on the homepage.}
  \item
    {User selects the ``Study'' button for the Class they want to view or
    shuffle cards for.}
  \item
    {The Client displays their Deck for the Class of interest.}
  \item
    {User clicks on ``shuffle deck'' button to shuffle the deck,
    randomizing the order in which it will be displayed.}
  \item
    {The Client displays a change in card ordering.}
  \item
    {System reorders cards' study order.}
  \end{enumerate}
  
  {Alternate Workflow: }
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User is on the homepage.}
  \item
    {User selects Class of interest.}
  \item
    {The Client displays the Live Feed for the Class.}
  \item
    {User clicks on ``shuffle deck'' button to shuffle the deck,
    randomizing the order in which it will be displayed.}
  \item
    {The Client displays a change in card ordering.}
  \item
    {System reorders cards' study order.}
  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1639
  \subsection{[D2] Viewing cards in deck by pull time}
9bdef2907   Andrew Buss   Converted design ...
1640
1641
1642
1643
  
  \begin{description}
  \item[Description]{The user is able to organize the deck by Flashcards'
  pull timestamps.}
45b5ec6b5   Andrew Buss   Fixed description...
1644
  \item[Desired Outcome]{The user views the deck in time ascending/descending
9bdef2907   Andrew Buss   Converted design ...
1645
  order.}
45b5ec6b5   Andrew Buss   Fixed description...
1646
  \\
9bdef2907   Andrew Buss   Converted design ...
1647
  \item[User Goals]{To organize the card for easier editing purpose.}
45b5ec6b5   Andrew Buss   Fixed description...
1648
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1649

45b5ec6b5   Andrew Buss   Fixed description...
1650
1651
1652
  \item[Dependency Use Cases]{View by pull timestamp.}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
  
  \item[Status]{In Progress}
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has an account with the application.}
  \item
    {User is logged in.}
  \item
    {User has a deck with at least 1 flashcard.}
  \item
    {User is at the deck view for a class.}
  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Cards in the deck are in time order.}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1677
  \item[Trigger]{User selects organize by add time.}
9bdef2907   Andrew Buss   Converted design ...
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The Client shows the user the Deck View.}
  \item
    {The User shall select the option to sort the deck by ascending time.}
  \item
    {The Client shall submit a form POST request to the server at
    /api/deck/ about the order}
  \item
    {The Server shall return the ordered view of the deck.}
  \item
    {The Client displays the cards in the ascending view of the pull
    time.}
  \end{enumerate}
  
  {}
  
  {Alternate WorkFlow:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The Client shows the user the Deck View.}
  \item
    {The User shall select the option to sort the deck by descending
    time.}
  \item
    {The Client shall submit a form POST request to the server at
    /api/deck/ about the order}
  \item
    {The Server shall return the descending view of the deck.}
  \item
    {The Client displays the cards in the descending view of the pull
    time.}
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
b816d0356   Andrew Buss   Added sections
1722
  \section{Review}
770e764f2   Melody   Might have possib...
1723
  \subsection{[R1] Study Deck}
9bdef2907   Andrew Buss   Converted design ...
1724
1725
1726
1727
  
  \begin{description}
  \item[Description]{The User shall be able to look at the cards in his/her
  deck in order to study them}
45b5ec6b5   Andrew Buss   Fixed description...
1728
  \item[Desired Outcome]{The User shall be presented with individual
9bdef2907   Andrew Buss   Converted design ...
1729
1730
  flashcards in an optimized order. Blanks will be empty and the user will
  have a text boxes to fill in.}
45b5ec6b5   Andrew Buss   Fixed description...
1731
  \\
9bdef2907   Andrew Buss   Converted design ...
1732
1733
  \item[User Goals]{The user shall be able to study all flashcards in his/her
  deck from the appropriate class.}
45b5ec6b5   Andrew Buss   Fixed description...
1734
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1735

45b5ec6b5   Andrew Buss   Fixed description...
1736
1737
1738
  \item[Dependency Use Cases]{{[}F1{]}}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1739
1740
  
  \item[Status]{Not Implemented}
45b5ec6b5   Andrew Buss   Fixed description...
1741
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
1742
1743
1744
1745
1746
1747
1748
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User is logged in}
  \item
    {User has added cards to his/her deck}
9bdef2907   Andrew Buss   Converted design ...
1749
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1750
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall see a single card with blanks.}
  \end{itemize}
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall be presented with text boxes to fill in}
  \end{itemize}
2ea9c20eb   Melody   Edited 'Study Deck'
1763
  \item[Trigger]{User wishes to study flashcards compiled for a specific class.}
9bdef2907   Andrew Buss   Converted design ...
1764

45b5ec6b5   Andrew Buss   Fixed description...
1765
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1766
1767
1768
1769
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1770
1771
1772
1773
1774
1775
1776
1777
    {The User shall view a class.}
  \item
    {The User shall click on the button ``Study Deck''.}
  \item
    {The Client shall send POST request to the Server for a flashcard (ordering
    based on a hidden algorithm).}
  \item
    {The Client shall display the Study View to the User with blanks to fill in.}
9bdef2907   Andrew Buss   Converted design ...
1778
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1779
    {The User shall fill in the blanks.}
9bdef2907   Andrew Buss   Converted design ...
1780
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1781
    {The Client shall send the User's response back to the Server in POST.}
9bdef2907   Andrew Buss   Converted design ...
1782
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1783
    {The Server shall inform the Client of how correct the User's repsonse was.}
9bdef2907   Andrew Buss   Converted design ...
1784
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1785
    {The Client shall display said results to User.}
9bdef2907   Andrew Buss   Converted design ...
1786
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1787
1788
1789
1790
1791
1792
    {The Client shall produce two buttons for the User, indicating whether or
    not the card was answered correctly based on the provided results.}
  \item
    {The User shall select their desired response.}
  \item
    {The Client shall relay response to server in a POST request.}
9bdef2907   Andrew Buss   Converted design ...
1793
1794
1795
  \item
    {The Server saves the response and updates statistics about the
    flashcard.}
2ea9c20eb   Melody   Edited 'Study Deck'
1796
1797
  \item
    {Loop back to 3.}
9bdef2907   Andrew Buss   Converted design ...
1798
1799
1800
1801
1802
1803
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1804
  \subsection{[R2] Review Notification}
9bdef2907   Andrew Buss   Converted design ...
1805
1806
1807
1808
  
  \begin{description}
  \item[Description]{The User shall be notified when to review each specific
  card}
45b5ec6b5   Andrew Buss   Fixed description...
1809
  \item[Desired Outcome]{The User shall receive a notification when it is
9bdef2907   Andrew Buss   Converted design ...
1810
  time to review a specific card using a spaced repetition formula}
45b5ec6b5   Andrew Buss   Fixed description...
1811
  \\
9bdef2907   Andrew Buss   Converted design ...
1812
1813
  \item[User Goals]{The user shall see the notification and which card needs
  to be reviewed}
45b5ec6b5   Andrew Buss   Fixed description...
1814
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1815

45b5ec6b5   Andrew Buss   Fixed description...
1816
1817
1818
  \item[Dependency Use Cases]{{[}A1{]}, {[}A2{]}}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1819
1820
  
  \item[Status]{Not Implemented}
45b5ec6b5   Andrew Buss   Fixed description...
1821
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has an account with the system. }
  \item
    {User is logged in.}
  \item
    {User has cards in his/her deck.}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1832
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
1833
1834
1835
1836
1837
1838
1839
1840
1841
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {System shall calculate when to next present the card based on a
    memory decay formula.}
  \item
    {User shall be notified.}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1842
  \item[Trigger]{The delay time for a card to be shown has passed}
9bdef2907   Andrew Buss   Converted design ...
1843

45b5ec6b5   Andrew Buss   Fixed description...
1844
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The Server analyzes a User's flashcard's statistics and when they
    last reviewed the card to determine when to send the flashcard
    notification.}
  \item
    {The Server shall send a notification to the User at the specified
    review time.}
  \item
    {The Client receives a ``Review Flashcard'' notification.}
  \item
2ea9c20eb   Melody   Edited 'Study Deck'
1858
1859
    {The Client displays a notification n Sidebar that allows the
    User to study the specified flashcards in the queue.}
9bdef2907   Andrew Buss   Converted design ...
1860
1861
1862
1863
1864
1865
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}
770e764f2   Melody   Might have possib...
1866
  \subsection{[R3] Configure Account Notifications}
9bdef2907   Andrew Buss   Converted design ...
1867
1868
1869
  \begin{description}
  \item[Description]{The User shall be able to turn notifications on or off
  at will}
45b5ec6b5   Andrew Buss   Fixed description...
1870
  \item[Desired Outcome]{The User shall only receive notifications at the
9bdef2907   Andrew Buss   Converted design ...
1871
  times that were specified}
45b5ec6b5   Andrew Buss   Fixed description...
1872
  \\
9bdef2907   Andrew Buss   Converted design ...
1873
1874
  \item[User Goals]{The User shall not be bothered needlessly or at
  inconvenient times}
45b5ec6b5   Andrew Buss   Fixed description...
1875
  \item[Primary Actor]{User (student)}
9bdef2907   Andrew Buss   Converted design ...
1876

45b5ec6b5   Andrew Buss   Fixed description...
1877
1878
1879
  \item[Dependency Use Cases]{\ldots{}}
  \\
  \item[Priority Level]{``Must''}
9bdef2907   Andrew Buss   Converted design ...
1880
1881
  
  \item[Status]{Not Implemented}
45b5ec6b5   Andrew Buss   Fixed description...
1882
  \item[Pre-conditions]
9bdef2907   Andrew Buss   Converted design ...
1883
1884
1885
1886
1887
1888
1889
1890
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has a verified account}
  \item
    {User is at application's home screen}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1891
  \item[Post-conditions]{}
9bdef2907   Andrew Buss   Converted design ...
1892
1893
1894
1895
1896
1897
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User only receive notifications at specified times}
  \end{itemize}
45b5ec6b5   Andrew Buss   Fixed description...
1898
  \item[Trigger]{User indicates that they want to change their notification
9bdef2907   Andrew Buss   Converted design ...
1899
  settings}
45b5ec6b5   Andrew Buss   Fixed description...
1900
  \item[Workflow]
9bdef2907   Andrew Buss   Converted design ...
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User selects ``Account Settings'' button from a header.}
  \item
    {The Client displays a settings screen.}
  \item
    {User shall modify notifications and settings as seen fit.}
  \item
    {User shall click ``Save Settings'' button.}
  \item
    {Client shall display a message confirming the settings are saved.}
  \item
    {System shall save notification settings to the user's attributes.}
  \end{enumerate}
  \end{description}
4d2ee9e3e   Chung Wang   A3 change. ( not...
1918
  \end{document}