110swag / docs

Download as
Browse Code ยป

Commit b088df505a2a8a3ce2600ddf59bcd06ae85ba4ea

Authored by Chung Wang
1 parent d8905e0668
Exists in master

A3 syntax fixed

Showing 1 changed file with 1 additions and 1 deletions Inline Diff

DesignUseCases.tex View file @ b088df5
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge Design Use Cases} 5 5 \title{\huge Design Use Cases}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Phuong Tran & Quality Assurance Lead \\ 37 37 Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\tableofcontents 44 44 \tableofcontents
\newpage 45 45 \newpage
\section{Accounts} 46 46 \section{Accounts}
\subsection{[A1] User Registration} 47 47 \subsection{[A1] User Registration}
\begin{description}[style=multiline,leftmargin=3cm] 48 48 \begin{description}[style=multiline,leftmargin=3cm]
\item[Description]{To create and save decks, the system requires the user 49 49 \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 50 50 to create an account prior. The user will be able to create an account
through registering.} 51 51 through registering.}
\item[Desired Outcome]{An account will be created for the user from the 52 52 \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 53 53 specified username, password, email. The user will be able to log into
the aforementioned account.} 54 54 the aforementioned account.}
\\ 55 55 \\
\item[User Goals]{The user shall have an account to participate in the 56 56 \item[User Goals]{The user shall have an account to participate in the
website's activities.} 57 57 website's activities.}
58 58
\item[Primary Actor]{User (student)} 59 59 \item[Primary Actor]{User (student)}
60 60
\item[Dependency Use Cases]{None} 61 61 \item[Dependency Use Cases]{None}
\\ 62 62 \\
\item[Priority Level]{``Must''} 63 63 \item[Priority Level]{``Must''}
64 64
\item[Status]{Not Implemented} 65 65 \item[Status]{Not Implemented}
66 66
\item[Pre-conditions] 67 67 \item[Pre-conditions]
68 68
\item[Post-conditions] 69 69 \item[Post-conditions]
70 70
\begin{itemize} 71 71 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 72 72 \itemsep1pt\parskip0pt\parsep0pt
\item 73 73 \item
{The user has an account registered with the system.} 74 74 {The user has an account registered with the system.}
\end{itemize} 75 75 \end{itemize}
76 76
\item[Trigger]{The user wants to create an account.} 77 77 \item[Trigger]{The user wants to create an account.}
78 78
\item[Workflow] 79 79 \item[Workflow]
80 80
\begin{enumerate} 81 81 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 82 82 \itemsep1pt\parskip0pt\parsep0pt
\item 83 83 \item
{The user shall click the sign up button.} 84 84 {The user shall click the sign up button.}
\item 85 85 \item
{The client renders a registration form and displays it to the user} 86 86 {The client renders a registration form and displays it to the user}
\item 87 87 \item
{The user fills the form} 88 88 {The user fills the form}
\item 89 89 \item
{The client checks that the provided email is not invalid, and that 90 90 {The client checks that the provided email is not invalid, and that
the password is not valid. If anything is not valid, it displays an 91 91 the password is not valid. If anything is not valid, it displays an
error and returns this to the user. } 92 92 error and returns this to the user. }
\item 93 93 \item
{If the form is valid, the client POSTs the form in JSON format to the 94 94 {If the form is valid, the client POSTs the form in JSON format to the
server API at /api/users/me.} 95 95 server API at /api/users/me.}
\item 96 96 \item
{The server deserializes and validates the data. If it's not valid, it 97 97 {The server deserializes and validates the data. If it's not valid, it
returns an error to the client.} 98 98 returns an error to the client.}
\item 99 99 \item
{The server creates a new User object from the provided data, filling 100 100 {The server creates a new User object from the provided data, filling
in the appropriate fields} 101 101 in the appropriate fields}
\item 102 102 \item
{The server saves the user object} 103 103 {The server saves the user object}
\item 104 104 \item
{The server marks the user's email as unverified} 105 105 {The server marks the user's email as unverified}
\item 106 106 \item
{The server sends an email to the user's address with a link to 107 107 {The server sends an email to the user's address with a link to
validate the user's email address.} 108 108 validate the user's email address.}
\item 109 109 \item
{The server responds with success and logs the user in on a new 110 110 {The server responds with success and logs the user in on a new
session for the user. } 111 111 session for the user. }
\item 112 112 \item
{The client reports success to the user and stores the sessionid for 113 113 {The client reports success to the user and stores the sessionid for
future requests.} 114 114 future requests.}
\end{enumerate} 115 115 \end{enumerate}
116 116
{Verification Workflow:} 117 117 {Verification Workflow:}
118 118
\begin{enumerate} 119 119 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 120 120 \itemsep1pt\parskip0pt\parsep0pt
\item 121 121 \item
{The user receives an email with a link to verify their email. The 122 122 {The user receives an email with a link to verify their email. The
user clicks the link} 123 123 user clicks the link}
\item 124 124 \item
{The client submits the verification code to the server} 125 125 {The client submits the verification code to the server}
\item 126 126 \item
{The server validates the code. If the code is not valid, it returns 127 127 {The server validates the code. If the code is not valid, it returns
an error to the client.} 128 128 an error to the client.}
\item 129 129 \item
{The server marks the user's email as valid and saves the User object 130 130 {The server marks the user's email as valid and saves the User object
again. The user's account is now active} 131 131 again. The user's account is now active}
\item 132 132 \item
{The client reports success. } 133 133 {The client reports success. }
\end{enumerate} 134 134 \end{enumerate}
135 135
\end{description} 136 136 \end{description}
137 137
\newpage 138 138 \newpage
\subsection{{{{[}A2{]} User 139 139 \subsection{{{{[}A2{]} User
Login}}{{[}A2{]} User Login}} 140 140 Login}}{{[}A2{]} User Login}}
141 141
\begin{description} 142 142 \begin{description}
\item[Description]{User is able to login to personal account.} 143 143 \item[Description]{User is able to login to personal account.}
144 144
\item[Desired Outcome]{The user shall be able to provide their username and 145 145 \item[Desired Outcome]{The user shall be able to provide their username and
password to access their courses and flash cards. The user shall gain 146 146 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 147 147 access to the list of the courses they have added, and be able to review
the flash cards they have added to their decks.} 148 148 the flash cards they have added to their decks.}
\\ 149 149 \\
\item[User Goals]{The user wants to resume use of the site on another 150 150 \item[User Goals]{The user wants to resume use of the site on another
device, or use the site after logging out.} 151 151 device, or use the site after logging out.}
152 152
\item[Primary Actor]{User (student)} 153 153 \item[Primary Actor]{User (student)}
154 154
\item[Dependency Use Cases]{{[}A1{]} User Registration} 155 155 \item[Dependency Use Cases]{{[}A1{]} User Registration}
\\ 156 156 \\
\item[Priority Level]{``Must''} 157 157 \item[Priority Level]{``Must''}
158 158
\item[Status]{Not Implemented} 159 159 \item[Status]{Not Implemented}
160 160
\item[Pre-conditions] 161 161 \item[Pre-conditions]
162 162
\begin{itemize} 163 163 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 164 164 \itemsep1pt\parskip0pt\parsep0pt
\item 165 165 \item
{The user has created an account before.} 166 166 {The user has created an account before.}
\end{itemize} 167 167 \end{itemize}
168 168
\item[Post-conditions] 169 169 \item[Post-conditions]
170 170
\begin{itemize} 171 171 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 172 172 \itemsep1pt\parskip0pt\parsep0pt
\item 173 173 \item
{The user can navigate the site and see their data.} 174 174 {The user can navigate the site and see their data.}
\end{itemize} 175 175 \end{itemize}
176 176
\item[Trigger]{The User shall enter their email and password into the Login 177 177 \item[Trigger]{The User shall enter their email and password into the Login
form. The user then submits this information by clicking the ``Login'' 178 178 form. The user then submits this information by clicking the ``Login''
button or pressing the return key.} 179 179 button or pressing the return key.}
180 180
\item[Workflow] 181 181 \item[Workflow]
182 182
\begin{enumerate} 183 183 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 184 184 \itemsep1pt\parskip0pt\parsep0pt
\item 185 185 \item
{The server verifies that the User has submitted an email and password} 186 186 {The server verifies that the User has submitted an email and password}
\item 187 187 \item
{The server authenticates the User's email and password and checks if the 188 188 {The server authenticates the User's email and password and checks if the
User is active} 189 189 User is active}
\item 190 190 \item
{The server logs the User in using the Django login feature} 191 191 {The server logs the User in using the Django login feature}
\item 192 192 \item
{Front-end displays the home page for the User} 193 193 {Front-end displays the home page for the User}
\end{enumerate} 194 194 \end{enumerate}
\end{description} 195 195 \end{description}
\newpage 196 196 \newpage
197 197
\subsection{{[}A3{]} Add a Class} 198 198 \subsection{{[}A3{]} Add a Class}
\begin{description} 199 199 \begin{description}
\item[Description]{The user shall be able to add a class and access the 200 200 \item[Description]{The user shall be able to add a class and access the
flashcards associated with that class.} 201 201 flashcards associated with that class.}
202 202
\item[Desired Outcome]{The class shall be linked with the student's account 203 203 \item[Desired Outcome]{The class shall be linked with the student's account
and the student shall have the ability to read and publish flashcards 204 204 and the student shall have the ability to read and publish flashcards
for this class.} 205 205 for this class.}
\\ 206 206 \\
\item[User Goals]{The user wants to publish flashcards for this class, and 207 207 \item[User Goals]{The user wants to publish flashcards for this class, and
reads the flashcards for this class that are published by other users.} 208 208 reads the flashcards for this class that are published by other users.}
209 209
\item[Primary Actor]{User (student)} 210 210 \item[Primary Actor]{User (student)}
211 211
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 212 212 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 213 213 Login}
\\ 214 214 \\
\item[Priority Level]{``Must''} 215 215 \item[Priority Level]{``Must''}
216 216
\item[Status]{Not implemented} 217 217 \item[Status]{Not implemented}
218 218
\item[Pre-conditions] 219 219 \item[Pre-conditions]
220 220
\begin{itemize} 221 221 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 222 222 \itemsep1pt\parskip0pt\parsep0pt
\item 223 223 \item
{The user has created an account.} 224 224 {The user has created an account.}
\item 225 225 \item
{The user is logged in to their account and is at root view} 226 226 {The user is logged in to their account and is at root view}
\end{itemize} 227 227 \end{itemize}
228 228
\item[Post-conditions] 229 229 \item[Post-conditions]
230 230
\begin{itemize} 231 231 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 232 232 \itemsep1pt\parskip0pt\parsep0pt
\item 233 233 \item
{The user can read the flashcards being published for the class and 234 234 {The user can read the flashcards being published for the class and
add them to his/her deck.} 235 235 add them to his/her deck.}
\item 236 236 \item
{The user can publish flashcards to be viewed and added by other users 237 237 {The user can publish flashcards to be viewed and added by other users
in the same class.} 238 238 in the same class.}
\end{itemize} 239 239 \end{itemize}
240 240
\item[Trigger]{The user wants to add a class.} 241 241 \item[Trigger]{The user wants to add a class.}
242 242
\item[Workflow] 243 243 \item[Workflow]
244 244
\begin{enumerate} 245 245 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 246 246 \itemsep1pt\parskip0pt\parsep0pt
\item 247 247 \item
{The user shall click add a class on the sidebar.} 248 248 {The user shall click add a class on the sidebar.}
\item 249 249 \item
{The client shall bring the user to a AddClassView.} 250 250 {The client shall bring the user to a AddClassView.}
\item 251 251 \item
{The user begins to type their class name or number.} 252 252 {The user begins to type their class name or number.}
\item 253 253 \item
{The ShowSuggestion shall show suggestions as a user types.} 254 254 {The ShowSuggestion shall show suggestions as a user types.}
\end{enumerate} 255 255 \end{enumerate}
256 256
\begin{itemize} 257 257 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 258 258 \itemsep1pt\parskip0pt\parsep0pt
\item 259 259 \item
{Implementation unspecified at present; need to do further research 260 260 {Implementation unspecified at present; need to do further research
(django-autocomplete-lite?)} 261 261 (django-autocomplete-lite?)}
\end{itemize} 262 262 \end{itemize}
263 263
\begin{enumerate} 264 264 \begin{enumerate}
\setcounter{enumi}{3} 265 265 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 266 266 \itemsep1pt\parskip0pt\parsep0pt
\item 267 267 \item
{The user shall select a class by clicking on ``Add Class''.} 268 268 {The user shall select a class by clicking on ``Add Class''.}
\item 269 269 \item
{The client shall submit a POST request to /api/users/me/sections with 270 270 {The client shall submit a POST request to /api/users/me/sections with
the course ID that the User added. } 271 271 the course ID that the User added. }
\item 272 272 \item
{The server shall check if there is a whitelist for the class that the 273 273 {The server shall check if there is a whitelist for the class that the
user is trying to add.} 274 274 user is trying to add.}
\item 275 275 \item
{The server shall ensure that the user is whitelisted.} 276 276 {The server shall ensure that the user is whitelisted.}
\item 277 277 \item
{The server shall link the user to the section.} 278 278 {The server shall link the user to the section.}
\end{enumerate} 279 279 \end{enumerate}
280 280
\item[Alternate Workflow: User is not whitelisted.] 281 281 \item[Alternate Workflow: User is not whitelisted.]
\begin{enumerate} 282 282 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 283 283 \itemsep1pt\parskip0pt\parsep0pt
\item 284 284 \item
{The server shall . } 285 285 {The server shall . }
286 286
\end(enumerate) 287 287 \end{enumerate}
\end{description} 288 288 \end{description}
{} 289 289 {}
290 290
\newpage 291 291 \newpage
292 292
{} 293 293 {}
294 294
\subsection{{{{[}A4{]} }{Drop a 295 295 \subsection{{{{[}A4{]} }{Drop a
Class}}{{[}A4{]} Drop a Class}} 296 296 Class}}{{[}A4{]} Drop a Class}}
297 297
\begin{description} 298 298 \begin{description}
\item[Description]{The user can remove themselves from a course he/she is 299 299 \item[Description]{The user can remove themselves from a course he/she is
registered to} 300 300 registered to}
301 301
\item[Desired Outcome]{The user has dropped the class and no longer need 302 302 \item[Desired Outcome]{The user has dropped the class and no longer need
access to the flashcards for said class. This means they can no longer 303 303 access to the flashcards for said class. This means they can no longer
see the flashcards associated to the class that they dropped } 304 304 see the flashcards associated to the class that they dropped }
\\ 305 305 \\
\item[User Goals]{The user shall not have access to a class and the 306 306 \item[User Goals]{The user shall not have access to a class and the
flashcards associated with that class. They will no longer see the class 307 307 flashcards associated with that class. They will no longer see the class
listed in their list of ``Enrolled Classes''} 308 308 listed in their list of ``Enrolled Classes''}
309 309
\item[Primary Actor]{User (student)} 310 310 \item[Primary Actor]{User (student)}
311 311
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 312 312 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 313 313 Login, {[}A3{]} Add a Class}
\\ 314 314 \\
\item[Priority Level]{ ``Should''} 315 315 \item[Priority Level]{ ``Should''}
316 316
\item[Status]{Not Implemented } 317 317 \item[Status]{Not Implemented }
318 318
\item[Pre-conditions] 319 319 \item[Pre-conditions]
320 320
\begin{itemize} 321 321 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 322 322 \itemsep1pt\parskip0pt\parsep0pt
\item 323 323 \item
{User has a valid account.} 324 324 {User has a valid account.}
\item 325 325 \item
{User is logged in.} 326 326 {User is logged in.}
\item 327 327 \item
{User has enrolled in classes.} 328 328 {User has enrolled in classes.}
\end{itemize} 329 329 \end{itemize}
330 330
\item[Post-conditions]{} 331 331 \item[Post-conditions]{}
332 332
\begin{itemize} 333 333 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 334 334 \itemsep1pt\parskip0pt\parsep0pt
\item 335 335 \item
{User shall no longer have access to dropped class, or associated 336 336 {User shall no longer have access to dropped class, or associated
flashcards} 337 337 flashcards}
\end{itemize} 338 338 \end{itemize}
339 339
\item[Trigger]{User clicked button to drop class.} 340 340 \item[Trigger]{User clicked button to drop class.}
341 341
\item[Workflow] 342 342 \item[Workflow]
343 343
\begin{enumerate} 344 344 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 345 345 \itemsep1pt\parskip0pt\parsep0pt
\item 346 346 \item
{The user shall click ``Drop'' (or equivalent) button.} 347 347 {The user shall click ``Drop'' (or equivalent) button.}
\item 348 348 \item
{The client shall display a dialogue box which will say ``Are you 349 349 {The client shall display a dialogue box which will say ``Are you
sure you want to drop this class?''} 350 350 sure you want to drop this class?''}
\item 351 351 \item
{The user shall click ``Yes'' to confirm that they want to drop the 352 352 {The user shall click ``Yes'' to confirm that they want to drop the
class} 353 353 class}
\item 354 354 \item
{The client shall submit a DELETE request to 355 355 {The client shall submit a DELETE request to
/api/users/me/sections/\textless{}section ID number\textgreater{}.} 356 356 /api/users/me/sections/\textless{}section ID number\textgreater{}.}
\item 357 357 \item
{If the user is not already enrolled in the section, the server will 358 358 {If the user is not already enrolled in the section, the server will
return a 404 Not Found error, which the client shall handle. (The 359 359 return a 404 Not Found error, which the client shall handle. (The
client should not show an error to the user)} 360 360 client should not show an error to the user)}
\item 361 361 \item
{The server shall remove the selected class from a user's list of 362 362 {The server shall remove the selected class from a user's list of
classes. } 363 363 classes. }
\item 364 364 \item
{The server shall return success to the client} 365 365 {The server shall return success to the client}
\end{enumerate} 366 366 \end{enumerate}
\end{description} 367 367 \end{description}
\newpage 368 368 \newpage
369 369
{} 370 370 {}
371 371
\subsection{{{{[}A5{]} Password 372 372 \subsection{{{{[}A5{]} Password
change}}{{[}A5{]} Password change}} 373 373 change}}{{[}A5{]} Password change}}
374 374
\begin{description} 375 375 \begin{description}
\item[Description]{The user shall be able to change the password for their 376 376 \item[Description]{The user shall be able to change the password for their
account in the account settings. This requires that they are logged in. 377 377 account in the account settings. This requires that they are logged in.
} 378 378 }
379 379
\item[Desired Outcome]{The user's password shall be changed and the user 380 380 \item[Desired Outcome]{The user's password shall be changed and the user
shall be able to log in with the new password in the future} 381 381 shall be able to log in with the new password in the future}
\\\\ 382 382 \\\\
\item[User Goals]{The user wants to use a different password in the future} 383 383 \item[User Goals]{The user wants to use a different password in the future}
384 384
\item[Primary Actor]{User (student)} 385 385 \item[Primary Actor]{User (student)}
386 386
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 387 387 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 388 388 Login}
\\ 389 389 \\
\item[Details]{The user provides their current password and a new password 390 390 \item[Details]{The user provides their current password and a new password
in a form. If the current password is correct, the system updates their 391 391 in a form. If the current password is correct, the system updates their
password to the requested new password.} 392 392 password to the requested new password.}
393 393
\item[Priority Level]{``Must''} 394 394 \item[Priority Level]{``Must''}
395 395
\item[Status]{Not }{implemented} 396 396 \item[Status]{Not }{implemented}
397 397
\item[Pre-conditions] 398 398 \item[Pre-conditions]
399 399
\begin{itemize} 400 400 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 401 401 \itemsep1pt\parskip0pt\parsep0pt
\item 402 402 \item
{The user has created an account} 403 403 {The user has created an account}
\item 404 404 \item
{The user has logged in } 405 405 {The user has logged in }
\item 406 406 \item
{The user knows their current password} 407 407 {The user knows their current password}
\end{itemize} 408 408 \end{itemize}
409 409
\item[Post-conditions] 410 410 \item[Post-conditions]
411 411
\begin{itemize} 412 412 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 413 413 \itemsep1pt\parskip0pt\parsep0pt
\item 414 414 \item
{The user's password is changed} 415 415 {The user's password is changed}
\item 416 416 \item
{The user can log in with the new password} 417 417 {The user can log in with the new password}
\end{itemize} 418 418 \end{itemize}
419 419
\item[Trigger]{User clicks ``Change Password'' button in Accounts page} 420 420 \item[Trigger]{User clicks ``Change Password'' button in Accounts page}
421 421
\item[Workflow] 422 422 \item[Workflow]
423 423
\begin{enumerate} 424 424 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 425 425 \itemsep1pt\parskip0pt\parsep0pt
\item 426 426 \item
{The user shall press the ``Change Password'' button} 427 427 {The user shall press the ``Change Password'' button}
\item 428 428 \item
{The client shall render a form that requires the user to enter their 429 429 {The client shall render a form that requires the user to enter their
old password and new password} 430 430 old password and new password}
\item 431 431 \item
{The user shall enter their current password and the desired new 432 432 {The user shall enter their current password and the desired new
password} 433 433 password}
\item 434 434 \item
{The client shall verify that no fields are blank} 435 435 {The client shall verify that no fields are blank}
\item 436 436 \item
{The client shall submit the data to the server by sending a PATCH 437 437 {The client shall submit the data to the server by sending a PATCH
request to /api/users/me containing ``old\_password'' and 438 438 request to /api/users/me containing ``old\_password'' and
``new\_password'' values.} 439 439 ``new\_password'' values.}
\item 440 440 \item
{The server shall validate the pre-existing password} 441 441 {The server shall validate the pre-existing password}
\item 442 442 \item
{If server cannot validate the pre-existing password, the client will 443 443 {If server cannot validate the pre-existing password, the client will
render the same form with a message informing the user that the 444 444 render the same form with a message informing the user that the
pre-existing password that they have provided is incorrect} 445 445 pre-existing password that they have provided is incorrect}
\item 446 446 \item
{If the server successfully validates the pre-existing password, the 447 447 {If the server successfully validates the pre-existing password, the
system shall change the user's password} 448 448 system shall change the user's password}
\item 449 449 \item
{The client shall return a success to the user} 450 450 {The client shall return a success to the user}
\end{enumerate} 451 451 \end{enumerate}
\end{description} 452 452 \end{description}
{} 453 453 {}
454 454
\newpage 455 455 \newpage
456 456
{} 457 457 {}
458 458
\subsection{{{{[}A6{]} Password reset 459 459 \subsection{{{{[}A6{]} Password reset
}}{{[}A6{]} Password reset }} 460 460 }}{{[}A6{]} Password reset }}
461 461
\begin{description} 462 462 \begin{description}
\item[Description]{The user shall be able to reset their password without 463 463 \item[Description]{The user shall be able to reset their password without
being logged in } 464 464 being logged in }
465 465
\item[Desired Outcome]{The user's password shall be changed to one that 466 466 \item[Desired Outcome]{The user's password shall be changed to one that
they remember} 467 467 they remember}
\\ 468 468 \\
\item[User Goals]{The user does not know their current password but wants 469 469 \item[User Goals]{The user does not know their current password but wants
to log into the site} 470 470 to log into the site}
471 471
\item[Primary Actor]{User (student)} 472 472 \item[Primary Actor]{User (student)}
473 473
\item[Dependency Use Cases]{{[}A1{]} User Registration} 474 474 \item[Dependency Use Cases]{{[}A1{]} User Registration}
\\ 475 475 \\
\item[Details]{The user provides their email in a password reset form. If 476 476 \item[Details]{The user provides their email in a password reset form. If
the address is valid, the site sends a password reset link with a random 477 477 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 478 478 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 479 479 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 480 480 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 481 481 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 482 482 password in a form. When they submit the form, their password is updated
if the token is correct. } 483 483 if the token is correct. }
484 484
\item[Priority Level]{``Must''} 485 485 \item[Priority Level]{``Must''}
486 486
\item[Status]{Not i}{mplemented} 487 487 \item[Status]{Not i}{mplemented}
488 488
\item[Pre-conditions] 489 489 \item[Pre-conditions]
490 490
\begin{itemize} 491 491 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 492 492 \itemsep1pt\parskip0pt\parsep0pt
\item 493 493 \item
{The user has created an account before} 494 494 {The user has created an account before}
\item 495 495 \item
{The user knows the email address attached to their account} 496 496 {The user knows the email address attached to their account}
\end{itemize} 497 497 \end{itemize}
498 498
\item[Post-conditions] 499 499 \item[Post-conditions]
500 500
\begin{itemize} 501 501 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 502 502 \itemsep1pt\parskip0pt\parsep0pt
\item 503 503 \item
{The user's password is changed} 504 504 {The user's password is changed}
\item 505 505 \item
{The user can log in with the new password} 506 506 {The user can log in with the new password}
\end{itemize} 507 507 \end{itemize}
508 508
\item[Trigger]{User clicks ``Forgot Password'' button on the login page} 509 509 \item[Trigger]{User clicks ``Forgot Password'' button on the login page}
510 510
\item[Workflow, requesting password reset] 511 511 \item[Workflow, requesting password reset]
512 512
\begin{enumerate} 513 513 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 514 514 \itemsep1pt\parskip0pt\parsep0pt
\item 515 515 \item
{The user shall click ``Forgot Password'' (or equivalent) button} 516 516 {The user shall click ``Forgot Password'' (or equivalent) button}
\item 517 517 \item
{The client shall prompt the user for their current email} 518 518 {The client shall prompt the user for their current email}
\item 519 519 \item
{The user shall submit their email address} 520 520 {The user shall submit their email address}
\item 521 521 \item
{The client shall validate that the email address is formatted 522 522 {The client shall validate that the email address is formatted
correctly} 523 523 correctly}
\item 524 524 \item
{The client shall submit the email address to the server in a POST 525 525 {The client shall submit the email address to the server in a POST
request to /api/reset\_password with an ``email'' value} 526 526 request to /api/reset\_password with an ``email'' value}
\item 527 527 \item
{The server shall check if an account exists with the email entered by 528 528 {The server shall check if an account exists with the email entered by
the user} 529 529 the user}
\item 530 530 \item
{If no such account exists, the server shall return an error to the 531 531 {If no such account exists, the server shall return an error to the
frontend, which will display it to the user} 532 532 frontend, which will display it to the user}
\item 533 533 \item
{If the account does exist, the server will:} 534 534 {If the account does exist, the server will:}
\end{enumerate} 535 535 \end{enumerate}
536 536
\begin{enumerate} 537 537 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 538 538 \itemsep1pt\parskip0pt\parsep0pt
\item 539 539 \item
{Create a new password reset token for the user} 540 540 {Create a new password reset token for the user}
\item 541 541 \item
{Send an email to the user with a link containing the token and the 542 542 {Send an email to the user with a link containing the token and the
user's ID} 543 543 user's ID}
\end{enumerate} 544 544 \end{enumerate}
545 545
\item[Workflow, resetting password] 546 546 \item[Workflow, resetting password]
547 547
\begin{enumerate} 548 548 \begin{enumerate}
\setcounter{enumi}{8} 549 549 \setcounter{enumi}{8}
\itemsep1pt\parskip0pt\parsep0pt 550 550 \itemsep1pt\parskip0pt\parsep0pt
\item 551 551 \item
{The user shall click the link in the email and visit 552 552 {The user shall click the link in the email and visit
/app/password\_reset} 553 553 /app/password\_reset}
\item 554 554 \item
{The client shall render a form that will prompt the user for a new 555 555 {The client shall render a form that will prompt the user for a new
password} 556 556 password}
\item 557 557 \item
{The user shall provide a new password in the form} 558 558 {The user shall provide a new password in the form}
\item 559 559 \item
{The client shall submit the password to the server} 560 560 {The client shall submit the password to the server}
\item 561 561 \item
{If the user tries to submit without a password in the text field, the 562 562 {If the user tries to submit without a password in the text field, the
client shall display a message saying ``Password cannot be blank.''} 563 563 client shall display a message saying ``Password cannot be blank.''}
\item 564 564 \item
{The server first verifies that the token is valid for the user} 565 565 {The server first verifies that the token is valid for the user}
\item 566 566 \item
{The server then verifies that the user's new password is non-blank} 567 567 {The server then verifies that the user's new password is non-blank}
\item 568 568 \item
{If neither of the above verifications fail, the server shall change 569 569 {If neither of the above verifications fail, the server shall change
the password associated with the user's email. } 570 570 the password associated with the user's email. }
\end{enumerate} 571 571 \end{enumerate}
\end{description} 572 572 \end{description}
\newpage 573 573 \newpage
574 574
{} 575 575 {}
576 576
\subsection{{{{[}A7{]} Limit Student Access to Courses 577 577 \subsection{{{{[}A7{]} Limit Student Access to Courses
}}{{[}A7{]} Limit Student Access to Courses }} 578 578 }}{{[}A7{]} Limit Student Access to Courses }}
579 579
\begin{description} 580 580 \begin{description}
\item[Description]{The instructor shall be able to limit access to the 581 581 \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 582 582 courses that he is in charge of by whitelisting only those students that
are actually in the class.} 583 583 are actually in the class.}
584 584
\item[Desired Outcome]{The class will have limited access and only those 585 585 \item[Desired Outcome]{The class will have limited access and only those
users who are whitelisted may enroll in the class.} 586 586 users who are whitelisted may enroll in the class.}
\\ 587 587 \\
\item[User Goals]{The instructor wants to limit access to his class so only 588 588 \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 589 589 the students who are actually in his class participate, and nobody
else.} 590 590 else.}
591 591
{Primary Actor: }{User (instructor)} 592 592 {Primary Actor: }{User (instructor)}
593 593
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 594 594 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 595 595 Login}
\\ 596 596 \\
\item[Priority Level]{``Should''} 597 597 \item[Priority Level]{``Should''}
598 598
\item[Status]{Not Implemented} 599 599 \item[Status]{Not Implemented}
600 600
\item[Pre-conditions] 601 601 \item[Pre-conditions]
602 602
\begin{itemize} 603 603 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 604 604 \itemsep1pt\parskip0pt\parsep0pt
\item 605 605 \item
{User has valid instructor's account} 606 606 {User has valid instructor's account}
\end{itemize} 607 607 \end{itemize}
608 608
\item[Post-conditions] 609 609 \item[Post-conditions]
610 610
\begin{itemize} 611 611 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 612 612 \itemsep1pt\parskip0pt\parsep0pt
\item 613 613 \item
{Only those users who were whitelisted may add the class.} 614 614 {Only those users who were whitelisted may add the class.}
\end{itemize} 615 615 \end{itemize}
616 616
\item[Trigger]{The instructor emails the administrator and requests to 617 617 \item[Trigger]{The instructor emails the administrator and requests to
limit access to his class.} 618 618 limit access to his class.}
619 619
\item[Workflow] 620 620 \item[Workflow]
621 621
\begin{enumerate} 622 622 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 623 623 \itemsep1pt\parskip0pt\parsep0pt
\item 624 624 \item
{The instructor emails the administrators from his UCSD email address 625 625 {The instructor emails the administrators from his UCSD email address
and requests to limit access to his course. He provides a list of 626 626 and requests to limit access to his course. He provides a list of
emails of the students that are to be whitelisted.} 627 627 emails of the students that are to be whitelisted.}
\item 628 628 \item
{The administrators visit a custom admin page, select the course, and 629 629 {The administrators visit a custom admin page, select the course, and
paste the list of emails. They submit the page directly (no separate 630 630 paste the list of emails. They submit the page directly (no separate
frontend here) to the server.} 631 631 frontend here) to the server.}
\item 632 632 \item
{The server shall create a WhitelistedAddress for each provided email, 633 633 {The server shall create a WhitelistedAddress for each provided email,
attaching it to the section taught by the instructor.} 634 634 attaching it to the section taught by the instructor.}
\item 635 635 \item
{The server shall add any existing users whose email addresses appear 636 636 {The server shall add any existing users whose email addresses appear
in the whitelist to the class. } 637 637 in the whitelist to the class. }
\end{enumerate} 638 638 \end{enumerate}
\end{description} 639 639 \end{description}
\newpage 640 640 \newpage
641 641
\subsection{{{{[}A8{]} User 642 642 \subsection{{{{[}A8{]} User
Logout}}{{[}A8{]} User Logout}} 643 643 Logout}}{{[}A8{]} User Logout}}
644 644
\begin{description} 645 645 \begin{description}
\item[Description]{The user shall be able to log out of his/her account on 646 646 \item[Description]{The user shall be able to log out of his/her account on
the site.} 647 647 the site.}
648 648
\item[Desired Outcome]{The user's information and data will no longer be 649 649 \item[Desired Outcome]{The user's information and data will no longer be
accessible after logging out. } 650 650 accessible after logging out. }
\\ 651 651 \\
\item[User Goals]{The user is done with his/her session of using the 652 652 \item[User Goals]{The user is done with his/her session of using the
website, and wants to make sure others cannot access the data in his/her 653 653 website, and wants to make sure others cannot access the data in his/her
account.} 654 654 account.}
655 655
\item[Primary Actor]{User (student)} 656 656 \item[Primary Actor]{User (student)}
657 657
\item[Dependency Use Cases] None 658 658 \item[Dependency Use Cases] None
\\ 659 659 \\
\item[Priority Level]{``Must''} 660 660 \item[Priority Level]{``Must''}
661 661
\item[Status]{Implemented} 662 662 \item[Status]{Implemented}
663 663
\item[Pre-conditions]{The user is logged into their account} 664 664 \item[Pre-conditions]{The user is logged into their account}
665 665
\item[Post-conditions]{}{The user's data can no longer be accessed.} 666 666 \item[Post-conditions]{}{The user's data can no longer be accessed.}
667 667
\item[Trigger]{User clicks ``Logout'' button} 668 668 \item[Trigger]{User clicks ``Logout'' button}
669 669
\item[Workflow] 670 670 \item[Workflow]
671 671
\begin{enumerate} 672 672 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 673 673 \itemsep1pt\parskip0pt\parsep0pt
\item 674 674 \item
{The server logs the User out using the Django logout feature} 675 675 {The server logs the User out using the Django logout feature}
\item 676 676 \item
{Front-end displays application login page} 677 677 {Front-end displays application login page}
\end{enumerate} 678 678 \end{enumerate}
679 679
\end{description} 680 680 \end{description}
681 681
\newpage 682 682 \newpage
683 683
684 684
685 685
\subsection{{{{[}A9{]} Contact 686 686 \subsection{{{{[}A9{]} Contact
Admin}}{{[}A9{]} Contact Admin}} 687 687 Admin}}{{[}A9{]} Contact Admin}}
688 688
\begin{description} 689 689 \begin{description}
\item[Description]{The user shall be able to contact the admin.} 690 690 \item[Description]{The user shall be able to contact the admin.}
691 691
\item[Desired Outcome]{The user shall send a message to the admin; the 692 692 \item[Desired Outcome]{The user shall send a message to the admin; the
admin shall receive the message.} 693 693 admin shall receive the message.}
694 694
{User Goals:}{The user sends a message to the admin.} 695 695 {User Goals:}{The user sends a message to the admin.}
696 696
\item[Primary Actor]{User} 697 697 \item[Primary Actor]{User}
698 698
\item[Dependency Use Cases]{None} 699 699 \item[Dependency Use Cases]{None}
\\ 700 700 \\
\item[Priority Level]{``Must''} 701 701 \item[Priority Level]{``Must''}
702 702
\item[Status]{Not implemented} 703 703 \item[Status]{Not implemented}
704 704
\item[Pre-conditions]{None.} 705 705 \item[Pre-conditions]{None.}
706 706
\item[Post-conditions]{The admin receives the user's message.} 707 707 \item[Post-conditions]{The admin receives the user's message.}
708 708
\item[Trigger]{User has navigated to our website. } 709 709 \item[Trigger]{User has navigated to our website. }
710 710
\item[Workflow] 711 711 \item[Workflow]
712 712
\begin{enumerate} 713 713 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 714 714 \itemsep1pt\parskip0pt\parsep0pt
\item 715 715 \item
{The frontend displays the admin email address on every page in the 716 716 {The frontend displays the admin email address on every page in the
application.} 717 717 application.}
\end{enumerate} 718 718 \end{enumerate}
\end{description} 719 719 \end{description}
\newpage 720 720 \newpage
721 721
{} 722 722 {}
\section{Flashcards} 723 723 \section{Flashcards}
\subsection{{{{[}F1{]} Push Flashcard 724 724 \subsection{{{{[}F1{]} Push Flashcard
}}{{[}F1{]} Push Flashcard }} 725 725 }}{{[}F1{]} Push Flashcard }}
726 726
\begin{description} 727 727 \begin{description}
\item[Description]{The user shall be able to create a flashcard with their 728 728 \item[Description]{The user shall be able to create a flashcard with their
input. } 729 729 input. }
730 730
\item[Desired Outcome]{The user shall have the flashcard added to their own 731 731 \item[Desired Outcome]{The user shall have the flashcard added to their own
deck and the Live Feed. } 732 732 deck and the Live Feed. }
\\ 733 733 \\
\item[User Goals]{The user will see their flashcard in their deck and the 734 734 \item[User Goals]{The user will see their flashcard in their deck and the
flashcard will be shared with others. } 735 735 flashcard will be shared with others. }
736 736
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 737 737 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 738 738 Login, {[}A3{]} Add a Class}
\\ 739 739 \\
\item[Pre-conditions] 740 740 \item[Pre-conditions]
741 741
\begin{itemize} 742 742 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 743 743 \itemsep1pt\parskip0pt\parsep0pt
\item 744 744 \item
{The User has an account } 745 745 {The User has an account }
\item 746 746 \item
{The User has added at least one class} 747 747 {The User has added at least one class}
\item 748 748 \item
{The User is on the class' page} 749 749 {The User is on the class' page}
\end{itemize} 750 750 \end{itemize}
751 751
\item[Post-conditions] 752 752 \item[Post-conditions]
753 753
\begin{itemize} 754 754 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 755 755 \itemsep1pt\parskip0pt\parsep0pt
\item 756 756 \item
{The User has flashcard added to their deck} 757 757 {The User has flashcard added to their deck}
\item 758 758 \item
{The Flashcard is shown in the Live Feed} 759 759 {The Flashcard is shown in the Live Feed}
\item 760 760 \item
{Other users can add this flashcard to their decks} 761 761 {Other users can add this flashcard to their decks}
\end{itemize} 762 762 \end{itemize}
763 763
\item[Trigger]{} 764 764 \item[Trigger]{}
765 765
\begin{itemize} 766 766 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 767 767 \itemsep1pt\parskip0pt\parsep0pt
\item 768 768 \item
{The User has clicked on the button ``Make New Flashcard''.} 769 769 {The User has clicked on the button ``Make New Flashcard''.}
\item 770 770 \item
{The Server receives a POST request containing the flashcard data.} 771 771 {The Server receives a POST request containing the flashcard data.}
\end{itemize} 772 772 \end{itemize}
773 773
\item[Workflow] 774 774 \item[Workflow]
775 775
\begin{enumerate} 776 776 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 777 777 \itemsep1pt\parskip0pt\parsep0pt
\item 778 778 \item
{The User is at the live feed for the class.} 779 779 {The User is at the live feed for the class.}
\item 780 780 \item
{The User shall click on the button}{Push 781 781 {The User shall click on the button}{Push
Flashcard} 782 782 Flashcard}
\item 783 783 \item
{The 784 784 {The
}{Client}{shall 785 785 }{Client}{shall
present a dialog box for inputting the flashcard text to the User.} 786 786 present a dialog box for inputting the flashcard text to the User.}
\item 787 787 \item
{The User shall input the flashcard text.} 788 788 {The User shall input the flashcard text.}
\item 789 789 \item
{Optionally, the User shall mark keywords in the flashcard text.} 790 790 {Optionally, the User shall mark keywords in the flashcard text.}
\item 791 791 \item
{If the User creates this flashcard outside of the lecture time, he 792 792 {If the User creates this flashcard outside of the lecture time, he
will get the option to change the material date.} 793 793 will get the option to change the material date.}
\item 794 794 \item
{The User shall click on the `Submit' button to submit the flashcard 795 795 {The User shall click on the `Submit' button to submit the flashcard
text, blanks, and material date, in JSON form as a POST request.} 796 796 text, blanks, and material date, in JSON form as a POST request.}
\item 797 797 \item
{The Server shall obtain the flashcard information by deserializing 798 798 {The Server shall obtain the flashcard information by deserializing
the JSON in the POST request.} 799 799 the JSON in the POST request.}
\item 800 800 \item
{The Server shall create a new record for this flashcard in the 801 801 {The Server shall create a new record for this flashcard in the
Flashcards table in the database.} 802 802 Flashcards table in the database.}
\item 803 803 \item
{The Server shall publish the newly created card to the live feed of 804 804 {The Server shall publish the newly created card to the live feed of
the class.} 805 805 the class.}
\end{enumerate} 806 806 \end{enumerate}
\end{description} 807 807 \end{description}
{Alternative Workflow:} 808 808 {Alternative Workflow:}
809 809
\begin{enumerate} 810 810 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 811 811 \itemsep1pt\parskip0pt\parsep0pt
\item 812 812 \item
{The User shall view a flashcard that he/she did not create} 813 813 {The User shall view a flashcard that he/she did not create}
\item 814 814 \item
{The User shall click ``Edit''} 815 815 {The User shall click ``Edit''}
\item 816 816 \item
{The client shall present a dialog box for editing the existing 817 817 {The client shall present a dialog box for editing the existing
flashcard text} 818 818 flashcard text}
\item 819 819 \item
{The User shall make edits} 820 820 {The User shall make edits}
\item 821 821 \item
{The User shall click ``save''} 822 822 {The User shall click ``save''}
\item 823 823 \item
{The client shall send a POST request} 824 824 {The client shall send a POST request}
\item 825 825 \item
{The server shall remove the original card from user's deck} 826 826 {The server shall remove the original card from user's deck}
\item 827 827 \item
{The Server shall obtain the flashcard information by deserializing 828 828 {The Server shall obtain the flashcard information by deserializing
the JSON in the POST request.} 829 829 the JSON in the POST request.}
\item 830 830 \item
{The Server shall create a new record for this flashcard in the 831 831 {The Server shall create a new record for this flashcard in the
Flashcards table in the database.} 832 832 Flashcards table in the database.}
\item 833 833 \item
{The Server shall publish the newly created card to the live feed of 834 834 {The Server shall publish the newly created card to the live feed of
the class.} 835 835 the class.}
\end{enumerate} 836 836 \end{enumerate}
837 837
\newpage 838 838 \newpage
839 839
{} 840 840 {}
841 841
\subsection{{{{[}F2{]} Edit 842 842 \subsection{{{{[}F2{]} Edit
Flashcard}}{{[}F2{]} Edit Flashcard}} 843 843 Flashcard}}{{[}F2{]} Edit Flashcard}}
844 844
\begin{description} 845 845 \begin{description}
\item[Description]{The user shall be able to edit the text on their own 846 846 \item[Description]{The user shall be able to edit the text on their own
flashcard } 847 847 flashcard }
848 848
\item[Desired Outcome]{Flashcard is edited and saved appropriately} 849 849 \item[Desired Outcome]{Flashcard is edited and saved appropriately}
\\ 850 850 \\
\item[User Goals]{To be able to change text on a flashcard} 851 851 \item[User Goals]{To be able to change text on a flashcard}
852 852
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 853 853 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull 854 854 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
Flashcard} 855 855 Flashcard}
856 856
\item[Pre-conditions] 857 857 \item[Pre-conditions]
858 858
\begin{itemize} 859 859 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 860 860 \itemsep1pt\parskip0pt\parsep0pt
\item 861 861 \item
{Flashcard is created} 862 862 {Flashcard is created}
\item 863 863 \item
{Flashcard in user's deck} 864 864 {Flashcard in user's deck}
\item 865 865 \item
{Flashcard is viewable} 866 866 {Flashcard is viewable}
\end{itemize} 867 867 \end{itemize}
868 868
\item[Post-conditions] 869 869 \item[Post-conditions]
870 870
\begin{itemize} 871 871 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 872 872 \itemsep1pt\parskip0pt\parsep0pt
\item 873 873 \item
{Flashcard is edited} 874 874 {Flashcard is edited}
\end{itemize} 875 875 \end{itemize}
876 876
\item[Trigger]{User has clicked ``Edit'' button when viewing a specific 877 877 \item[Trigger]{User has clicked ``Edit'' button when viewing a specific
flashcard} 878 878 flashcard}
879 879
\item[Workflow] 880 880 \item[Workflow]
881 881
\begin{enumerate} 882 882 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 883 883 \itemsep1pt\parskip0pt\parsep0pt
\item 884 884 \item
{The user shall view their deck} 885 885 {The user shall view their deck}
\item 886 886 \item
{The client shall present user with a grid view of cards in 887 887 {The client shall present user with a grid view of cards in
chronological creation order} 888 888 chronological creation order}
\item 889 889 \item
{The user shall select a flashcard and click `Edit'} 890 890 {The user shall select a flashcard and click `Edit'}
\item 891 891 \item
{The client shall produce an editable dialog box containing flashcard 892 892 {The client shall produce an editable dialog box containing flashcard
text} 893 893 text}
\item 894 894 \item
{The user shall make desired changes} 895 895 {The user shall make desired changes}
\item 896 896 \item
{The user shall click `Save'} 897 897 {The user shall click `Save'}
\item 898 898 \item
{The client shall generate a POST request for a new flashcard and send 899 899 {The client shall generate a POST request for a new flashcard and send
it to the server} 900 900 it to the server}
\item 901 901 \item
{If the user changed only the blanks of the cards, the server shall 902 902 {If the user changed only the blanks of the cards, the server shall
create a new FlashcardMask object and update the appropriate 903 903 create a new FlashcardMask object and update the appropriate
UserFlashcard object with a reference to it.} 904 904 UserFlashcard object with a reference to it.}
\item 905 905 \item
{If the user changed the text of the card, the server will instead:} 906 906 {If the user changed the text of the card, the server will instead:}
\end{enumerate} 907 907 \end{enumerate}
908 908
\begin{enumerate} 909 909 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 910 910 \itemsep1pt\parskip0pt\parsep0pt
\item 911 911 \item
{create a new flashcard for the section} 912 912 {create a new flashcard for the section}
\item 913 913 \item
{push it to the feed} 914 914 {push it to the feed}
\item 915 915 \item
{add it to the user's deck} 916 916 {add it to the user's deck}
\item 917 917 \item
{hide the old card from the user} 918 918 {hide the old card from the user}
\item 919 919 \item
{and return the new card to the user} 920 920 {and return the new card to the user}
\end{enumerate} 921 921 \end{enumerate}
\end{description} 922 922 \end{description}
{} 923 923 {}
924 924
\newpage 925 925 \newpage
926 926
{} 927 927 {}
928 928
\subsection{{{{[}F3{]} Pull 929 929 \subsection{{{{[}F3{]} Pull
Flashcard}}{{[}F3{]} Pull Flashcard}} 930 930 Flashcard}}{{[}F3{]} Pull Flashcard}}
\begin{description} 931 931 \begin{description}
\item[Description]{The User shall be able to add flash cards to their own 932 932 \item[Description]{The User shall be able to add flash cards to their own
deck from the Live Feed. } 933 933 deck from the Live Feed. }
934 934
\item[Desired Outcome]{The User shall have the flashcard added to their own 935 935 \item[Desired Outcome]{The User shall have the flashcard added to their own
deck } 936 936 deck }
\\ 937 937 \\
\item[User Goals]{The user will be able to review that flashcard. } 938 938 \item[User Goals]{The user will be able to review that flashcard. }
939 939
\item[Primary Actor]{User (student)} 940 940 \item[Primary Actor]{User (student)}
941 941
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 942 942 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard} 943 943 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard}
\\ 944 944 \\
\item[Priority Level]{``Must'' } 945 945 \item[Priority Level]{``Must'' }
946 946
\item[Status]{Not Implemented} 947 947 \item[Status]{Not Implemented}
948 948
\item[Pre-conditions] 949 949 \item[Pre-conditions]
950 950
\begin{itemize} 951 951 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 952 952 \itemsep1pt\parskip0pt\parsep0pt
\item 953 953 \item
{Flashcard has been created } 954 954 {Flashcard has been created }
\item 955 955 \item
{That flashcard is in the Live Feed} 956 956 {That flashcard is in the Live Feed}
\end{itemize} 957 957 \end{itemize}
958 958
\item[Post-conditions] 959 959 \item[Post-conditions]
960 960
\begin{itemize} 961 961 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 962 962 \itemsep1pt\parskip0pt\parsep0pt
\item 963 963 \item
{User shall have that flashcard added to their deck} 964 964 {User shall have that flashcard added to their deck}
\item 965 965 \item
{User can review this flashcard later} 966 966 {User can review this flashcard later}
\end{itemize} 967 967 \end{itemize}
968 968
\item[Trigger]{User has clicked on the flashcard in the Live Feed.} 969 969 \item[Trigger]{User has clicked on the flashcard in the Live Feed.}
970 970
\item[Workflow] 971 971 \item[Workflow]
972 972
\begin{enumerate} 973 973 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 974 974 \itemsep1pt\parskip0pt\parsep0pt
\item 975 975 \item
{The User is in the Live Feed.} 976 976 {The User is in the Live Feed.}
\item 977 977 \item
{User shall click on the ``Pull Flashcard'' button on a Flashcard in 978 978 {User shall click on the ``Pull Flashcard'' button on a Flashcard in
the Feed.} 979 979 the Feed.}
\item 980 980 \item
{The Client shall make the pulled Flashcard disappear from the Live 981 981 {The Client shall make the pulled Flashcard disappear from the Live
Feed} 982 982 Feed}
\item 983 983 \item
{The Client shall make the pulled Flashcard appear in the User's Deck 984 984 {The Client shall make the pulled Flashcard appear in the User's Deck
on the sidebar.} 985 985 on the sidebar.}
\item 986 986 \item
{The Client shall submit a POST request to 987 987 {The Client shall submit a POST request to
/api/flashcards/\textless{}flashcard id\textgreater{}/pull} 988 988 /api/flashcards/\textless{}flashcard id\textgreater{}/pull}
\item 989 989 \item
{The server shall create a UserFlashcard object to represent that the 990 990 {The server shall create a UserFlashcard object to represent that the
user's deck contains the card.} 991 991 user's deck contains the card.}
\item 992 992 \item
{The server shall notify connected clients about the new card rating, 993 993 {The server shall notify connected clients about the new card rating,
if any} 994 994 if any}
\item 995 995 \item
{Connected clients will take the new rating into account when next 996 996 {Connected clients will take the new rating into account when next
rearranging the feed.} 997 997 rearranging the feed.}
\end{enumerate} 998 998 \end{enumerate}
\end{description} 999 999 \end{description}
\newpage 1000 1000 \newpage
1001 1001
{} 1002 1002 {}
1003 1003
\subsection{{{{[}F4{]} Flag Inappropriate 1004 1004 \subsection{{{{[}F4{]} Flag Inappropriate
Cards}}{{[}F4{]} Flag Inappropriate Cards}} 1005 1005 Cards}}{{[}F4{]} Flag Inappropriate Cards}}
1006 1006
\begin{description} 1007 1007 \begin{description}
\item[Description]{Cards may be flagged indicating inappropriate content} 1008 1008 \item[Description]{Cards may be flagged indicating inappropriate content}
1009 1009
\item[Desired Outcome]{The flashcard's inappropriateness variable is 1010 1010 \item[Desired Outcome]{The flashcard's inappropriateness variable is
adjusted} 1011 1011 adjusted}
\\ 1012 1012 \\
\item[User Goals]{To note if a card should not belong in the class and 1013 1013 \item[User Goals]{To note if a card should not belong in the class and
should not be displayed in the feed} 1014 1014 should not be displayed in the feed}
1015 1015
\item[Primary Actor]{User (Student)} 1016 1016 \item[Primary Actor]{User (Student)}
1017 1017
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1018 1018 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1019 1019 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1020 1020 \\
\item[Priority Level]{``Should''} 1021 1021 \item[Priority Level]{``Should''}
1022 1022
\item[Status]{Unimplemented} 1023 1023 \item[Status]{Unimplemented}
1024 1024
\item[Pre-conditions] 1025 1025 \item[Pre-conditions]
1026 1026
\begin{itemize} 1027 1027 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1028 1028 \itemsep1pt\parskip0pt\parsep0pt
\item 1029 1029 \item
{User is enrolled in a class} 1030 1030 {User is enrolled in a class}
\end{itemize} 1031 1031 \end{itemize}
1032 1032
\begin{itemize} 1033 1033 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1034 1034 \itemsep1pt\parskip0pt\parsep0pt
\item 1035 1035 \item
{Flashcard is created} 1036 1036 {Flashcard is created}
\item 1037 1037 \item
{Flashcard is viewable in feed} 1038 1038 {Flashcard is viewable in feed}
\end{itemize} 1039 1039 \end{itemize}
1040 1040
\item[Post-conditions] 1041 1041 \item[Post-conditions]
1042 1042
\begin{itemize} 1043 1043 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1044 1044 \itemsep1pt\parskip0pt\parsep0pt
\item 1045 1045 \item
{Flashcard is hidden from user} 1046 1046 {Flashcard is hidden from user}
\item 1047 1047 \item
{Flashcard internal variable is adjusted} 1048 1048 {Flashcard internal variable is adjusted}
\end{itemize} 1049 1049 \end{itemize}
1050 1050
\item[Trigger]{User clicks flag on a specific flashcard} 1051 1051 \item[Trigger]{User clicks flag on a specific flashcard}
1052 1052
\item[Workflow] 1053 1053 \item[Workflow]
1054 1054
\begin{enumerate} 1055 1055 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1056 1056 \itemsep1pt\parskip0pt\parsep0pt
\item 1057 1057 \item
{The User is at a page of their classes.} 1058 1058 {The User is at a page of their classes.}
\item 1059 1059 \item
{The User selects one of their classes to enter the Live Feed.} 1060 1060 {The User selects one of their classes to enter the Live Feed.}
\item 1061 1061 \item
{The User is on the Live Feed for his/her class.} 1062 1062 {The User is on the Live Feed for his/her class.}
\item 1063 1063 \item
{The User shall identify an inappropriate card and flag the card.} 1064 1064 {The User shall identify an inappropriate card and flag the card.}
\item 1065 1065 \item
{The User clicks the ``Flag as Inappropriate'' button on the flashcard 1066 1066 {The User clicks the ``Flag as Inappropriate'' button on the flashcard
that he/she wants to report} 1067 1067 that he/she wants to report}
\item 1068 1068 \item
{The Client shall hide the card from the user} 1069 1069 {The Client shall hide the card from the user}
\item 1070 1070 \item
{The server shall create a FlashcardReport object} 1071 1071 {The server shall create a FlashcardReport object}
\end{enumerate} 1072 1072 \end{enumerate}
\end{description} 1073 1073 \end{description}
{} 1074 1074 {}
1075 1075
{} 1076 1076 {}
1077 1077
\newpage 1078 1078 \newpage
1079 1079
{} 1080 1080 {}
1081 1081
\subsection{{{{[}F5{]} Filter 1082 1082 \subsection{{{{[}F5{]} Filter
Flashcards}}{{[}F5{]} Filter Flashcards}} 1083 1083 Flashcards}}{{[}F5{]} Filter Flashcards}}
1084 1084
\begin{description} 1085 1085 \begin{description}
\item[Description]{The user is able to filter for flashcards by date} 1086 1086 \item[Description]{The user is able to filter for flashcards by date}
1087 1087
\item[Desired Outcome]{The user shall see flashcards based on the filter 1088 1088 \item[Desired Outcome]{The user shall see flashcards based on the filter
options} 1089 1089 options}
1090 1090
{User Goals:}{The user can find what he/she is specifically looking 1091 1091 {User Goals:}{The user can find what he/she is specifically looking
for} 1092 1092 for}
1093 1093
\item[Primary Actor]{User (student)} 1094 1094 \item[Primary Actor]{User (student)}
1095 1095
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1096 1096 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull 1097 1097 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
Flashcard} 1098 1098 Flashcard}
\\ 1099 1099 \\
\item[Priority Level]{''Should''} 1100 1100 \item[Priority Level]{''Should''}
1101 1101
\item[Status]{Not}{}{Implemented } 1102 1102 \item[Status]{Not}{}{Implemented }
1103 1103
\item[Pre-conditions] 1104 1104 \item[Pre-conditions]
1105 1105
\begin{itemize} 1106 1106 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1107 1107 \itemsep1pt\parskip0pt\parsep0pt
\item 1108 1108 \item
{User has registered for the course } 1109 1109 {User has registered for the course }
\item 1110 1110 \item
{Flashcards exist in the course} 1111 1111 {Flashcards exist in the course}
\end{itemize} 1112 1112 \end{itemize}
1113 1113
\item[Post-conditions]{} 1114 1114 \item[Post-conditions]{}
1115 1115
\begin{itemize} 1116 1116 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1117 1117 \itemsep1pt\parskip0pt\parsep0pt
\item 1118 1118 \item
{User only sees specific flashcards} 1119 1119 {User only sees specific flashcards}
\end{itemize} 1120 1120 \end{itemize}
1121 1121
\item[Trigger]{User has selected advanced options from menu} 1122 1122 \item[Trigger]{User has selected advanced options from menu}
1123 1123
\item[Workflow] 1124 1124 \item[Workflow]
1125 1125
\begin{enumerate} 1126 1126 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1127 1127 \itemsep1pt\parskip0pt\parsep0pt
\item 1128 1128 \item
{The User chooses one of their classes.} 1129 1129 {The User chooses one of their classes.}
\item 1130 1130 \item
{The User presses the class they want to view.} 1131 1131 {The User presses the class they want to view.}
\item 1132 1132 \item
{The Client displays the Live Feed.} 1133 1133 {The Client displays the Live Feed.}
\item 1134 1134 \item
{The User is at the Live Feed.} 1135 1135 {The User is at the Live Feed.}
\item 1136 1136 \item
{The User wants to filter the cards on the Live Feed.} 1137 1137 {The User wants to filter the cards on the Live Feed.}
\item 1138 1138 \item
{The User shall select what filter option they want from a drop down 1139 1139 {The User shall select what filter option they want from a drop down
menu.} 1140 1140 menu.}
\item 1141 1141 \item
{The Client shall display only relevant flashcards.} 1142 1142 {The Client shall display only relevant flashcards.}
\end{enumerate} 1143 1143 \end{enumerate}
\end{description} 1144 1144 \end{description}
{} 1145 1145 {}
1146 1146
\newpage 1147 1147 \newpage
1148 1148
{} 1149 1149 {}
1150 1150
\subsection{{{{[}F6{]} Blank Out Words in 1151 1151 \subsection{{{{[}F6{]} Blank Out Words in
Flashcard}}{{[}F6{]} Blank Out Words in Flashcard}} 1152 1152 Flashcard}}{{[}F6{]} Blank Out Words in Flashcard}}
1153 1153
\begin{description} 1154 1154 \begin{description}
\item[Description]{The User shall be able to blank out keywords in any 1155 1155 \item[Description]{The User shall be able to blank out keywords in any
flashcard in his deck. } 1156 1156 flashcard in his deck. }
1157 1157
\item[Desired Outcome]{The blanked out words in the flashcard notify the 1158 1158 \item[Desired Outcome]{The blanked out words in the flashcard notify the
System that they are keywords. } 1159 1159 System that they are keywords. }
\\ 1160 1160 \\
\item[User Goals]{The User shall mark some words as keywords so the System 1161 1161 \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 1162 1162 may later quiz theirself by blanking out the keywords and having the
User guess what they are.} 1163 1163 User guess what they are.}
1164 1164
{Primary Actor: }{User (student)} 1165 1165 {Primary Actor: }{User (student)}
1166 1166
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1167 1167 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1168 1168 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1169 1169 \\
\item[Priority Level]{``Must''} 1170 1170 \item[Priority Level]{``Must''}
1171 1171
\item[Status]{Not implemented.} 1172 1172 \item[Status]{Not implemented.}
1173 1173
\item[Pre-conditions] 1174 1174 \item[Pre-conditions]
1175 1175
\begin{itemize} 1176 1176 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1177 1177 \itemsep1pt\parskip0pt\parsep0pt
\item 1178 1178 \item
{The User has the flashcard he wishes to blank out words from in his 1179 1179 {The User has the flashcard he wishes to blank out words from in his
deck.} 1180 1180 deck.}
\item 1181 1181 \item
{The User shall (be on the class page and) view deck} 1182 1182 {The User shall (be on the class page and) view deck}
\end{itemize} 1183 1183 \end{itemize}
1184 1184
{Post-conditions: } 1185 1185 {Post-conditions: }
1186 1186
\begin{itemize} 1187 1187 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1188 1188 \itemsep1pt\parskip0pt\parsep0pt
\item 1189 1189 \item
{The blanked out words in the flashcard are marked as keywords.} 1190 1190 {The blanked out words in the flashcard are marked as keywords.}
\item 1191 1191 \item
{The System shall blank out the keywords and let the User guess what 1192 1192 {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.} 1193 1193 they are when it presents the flashcard to the User for reviewing.}
\end{itemize} 1194 1194 \end{itemize}
1195 1195
\item[Trigger]{The User clicks on a flashcard.} 1196 1196 \item[Trigger]{The User clicks on a flashcard.}
1197 1197
\item[Workflow] 1198 1198 \item[Workflow]
1199 1199
\begin{enumerate} 1200 1200 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1201 1201 \itemsep1pt\parskip0pt\parsep0pt
\item 1202 1202 \item
{The Client shall a show deck to user} 1203 1203 {The Client shall a show deck to user}
\item 1204 1204 \item
{The User shall click on the flashcard in his deck that he wants to 1205 1205 {The User shall click on the flashcard in his deck that he wants to
blank out words from} 1206 1206 blank out words from}
\item 1207 1207 \item
{The client shall bring user to edit flashcard page/popup} 1208 1208 {The client shall bring user to edit flashcard page/popup}
\item 1209 1209 \item
{The User shall click on the words that he wishes to blank out} 1210 1210 {The User shall click on the words that he wishes to blank out}
\item 1211 1211 \item
{The client shall specify a character range as blank} 1212 1212 {The client shall specify a character range as blank}
\item 1213 1213 \item
{The server shall mark those words by updating the Flashcard Mask for 1214 1214 {The server shall mark those words by updating the Flashcard Mask for
that flashcard. } 1215 1215 that flashcard. }
\item 1216 1216 \item
{The User shall click on `Save' or the equivalent button to save the 1217 1217 {The User shall click on `Save' or the equivalent button to save the
changes} 1218 1218 changes}
\item 1219 1219 \item
{The server will save the blanked out words as keywords to the 1220 1220 {The server will save the blanked out words as keywords to the
Flashcard Mask to review} 1221 1221 Flashcard Mask to review}
\item 1222 1222 \item
{The client shall cover the keywords with whitespace to hide them from 1223 1223 {The client shall cover the keywords with whitespace to hide them from
the User} 1224 1224 the User}
\end{enumerate} 1225 1225 \end{enumerate}
1226 1226
{Alternative Workflows:} 1227 1227 {Alternative Workflows:}
1228 1228
\begin{enumerate} 1229 1229 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1230 1230 \itemsep1pt\parskip0pt\parsep0pt
\item 1231 1231 \item
{The User shall (be on the class page and) click ``Make New 1232 1232 {The User shall (be on the class page and) click ``Make New
Flashcard''} 1233 1233 Flashcard''}
\item 1234 1234 \item
{The client shall present user with a new flashcard to fill in} 1235 1235 {The client shall present user with a new flashcard to fill in}
\item 1236 1236 \item
{The User shall fill in the information} 1237 1237 {The User shall fill in the information}
\item 1238 1238 \item
{The client shall ask if the user wants to specify blanks} 1239 1239 {The client shall ask if the user wants to specify blanks}
\item 1240 1240 \item
{The System will save the blanked out words as keywords to the 1241 1241 {The System will save the blanked out words as keywords to the
Flashcard Mask to review} 1242 1242 Flashcard Mask to review}
\item 1243 1243 \item
{The client shall cover the keywords with whitespace to hide them from 1244 1244 {The client shall cover the keywords with whitespace to hide them from
the User} 1245 1245 the User}
\end{enumerate} 1246 1246 \end{enumerate}
\end{description} 1247 1247 \end{description}
{} 1248 1248 {}
1249 1249
\newpage 1250 1250 \newpage
1251 1251
{} 1252 1252 {}
1253 1253
\subsection{{{{[}F7{]} Fix 1254 1254 \subsection{{{{[}F7{]} Fix
Flashcard}}{{[}F7{]} Fix Flashcard}} 1255 1255 Flashcard}}{{[}F7{]} Fix Flashcard}}
1256 1256
\begin{description} 1257 1257 \begin{description}
\item[Description]{The User shall be able to alter a flashcard he/she made 1258 1258 \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.} 1259 1259 originally and not have to make a new copy of it.}
1260 1260
\item[Desired Outcome]{The User shall alter one flashcard and that 1261 1261 \item[Desired Outcome]{The User shall alter one flashcard and that
alteration will be shown to all users of that flashcard} 1262 1262 alteration will be shown to all users of that flashcard}
\\ 1263 1263 \\
\item[User Goals]{The user shall make the flashcard say something different 1264 1264 \item[User Goals]{The user shall make the flashcard say something different
than it did originally.} 1265 1265 than it did originally.}
1266 1266
\item[Primary Actor]{User (student) } 1267 1267 \item[Primary Actor]{User (student) }
1268 1268
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1269 1269 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1270 1270 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1271 1271 \\
\item[Priority Level]{Must} 1272 1272 \item[Priority Level]{Must}
1273 1273
\item[Status]{Not Implemented} 1274 1274 \item[Status]{Not Implemented}
1275 1275
\item[Pre-conditions] 1276 1276 \item[Pre-conditions]
1277 1277
\begin{itemize} 1278 1278 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1279 1279 \itemsep1pt\parskip0pt\parsep0pt
\item 1280 1280 \item
{User has created the flashcard} 1281 1281 {User has created the flashcard}
\end{itemize} 1282 1282 \end{itemize}
1283 1283
\item[Post-conditions]{} 1284 1284 \item[Post-conditions]{}
1285 1285
\begin{itemize} 1286 1286 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1287 1287 \itemsep1pt\parskip0pt\parsep0pt
\item 1288 1288 \item
{The user shall see their alteration for that flashcard} 1289 1289 {The user shall see their alteration for that flashcard}
\item 1290 1290 \item
{Other users will be notified of the alteration} 1291 1291 {Other users will be notified of the alteration}
\end{itemize} 1292 1292 \end{itemize}
1293 1293
\item[Trigger]{User (creator of original card) has clicked on the button 1294 1294 \item[Trigger]{User (creator of original card) has clicked on the button
``Edit''} 1295 1295 ``Edit''}
1296 1296
\item[Workflow] 1297 1297 \item[Workflow]
1298 1298
\begin{enumerate} 1299 1299 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1300 1300 \itemsep1pt\parskip0pt\parsep0pt
\item 1301 1301 \item
{User shall select one of the Flashcards they authored.} 1302 1302 {User shall select one of the Flashcards they authored.}
\item 1303 1303 \item
{User shall select ``Edit'' button on the flashcard.} 1304 1304 {User shall select ``Edit'' button on the flashcard.}
\item 1305 1305 \item
{Client shall display an ``Edit Flashcard'' view.} 1306 1306 {Client shall display an ``Edit Flashcard'' view.}
\item 1307 1307 \item
{The Flashcard will display editable fields/areas.} 1308 1308 {The Flashcard will display editable fields/areas.}
\item 1309 1309 \item
{The User shall input any changes to the Flashcard.} 1310 1310 {The User shall input any changes to the Flashcard.}
\item 1311 1311 \item
{The User shall select the ``Done Editing'' button.} 1312 1312 {The User shall select the ``Done Editing'' button.}
\item 1313 1313 \item
{The Client shall close the ``Edit Flashcard'' view.} 1314 1314 {The Client shall close the ``Edit Flashcard'' view.}
\item 1315 1315 \item
{The server shall update the Flashcard's content.} 1316 1316 {The server shall update the Flashcard's content.}
\item 1317 1317 \item
{Client shall notify users with the Flashcard that the Flashcard has 1318 1318 {Client shall notify users with the Flashcard that the Flashcard has
been edited, allowing the other users to keep or to discard the 1319 1319 been edited, allowing the other users to keep or to discard the
changes.} 1320 1320 changes.}
\end{enumerate} 1321 1321 \end{enumerate}
\end{description} 1322 1322 \end{description}
{} 1323 1323 {}
1324 1324
{} 1325 1325 {}
1326 1326
{} 1327 1327 {}
1328 1328
\newpage 1329 1329 \newpage
1330 1330
{} 1331 1331 {}
1332 1332
\subsection{{{{[}F8{]} Hide cards from 1333 1333 \subsection{{{{[}F8{]} Hide cards from
feed}}{{[}F8{]} Hide cards from feed}} 1334 1334 feed}}{{[}F8{]} Hide cards from feed}}
1335 1335
\begin{description} 1336 1336 \begin{description}
\item[Description]{The user shall be able to hide cards from feed} 1337 1337 \item[Description]{The user shall be able to hide cards from feed}
1338 1338
\item[Desired Outcome]{The card is no longer visible to the user} 1339 1339 \item[Desired Outcome]{The card is no longer visible to the user}
\\ 1340 1340 \\
\item[User Goals]{The card has been looked at and should be hidden to 1341 1341 \item[User Goals]{The card has been looked at and should be hidden to
reduce screen clutter} 1342 1342 reduce screen clutter}
1343 1343
{Primary Actor: }{User (Student)} 1344 1344 {Primary Actor: }{User (Student)}
1345 1345
\item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User 1346 1346 \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1347 1347 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1348 1348 \\
\item[Priority Level]{``Should''} 1349 1349 \item[Priority Level]{``Should''}
1350 1350
{Status:}{Not implemented} 1351 1351 {Status:}{Not implemented}
1352 1352
\item[Pre-conditions]{Flashcard is created, flashcard is viewable by user} 1353 1353 \item[Pre-conditions]{Flashcard is created, flashcard is viewable by user}
1354 1354
\item[Post-conditions]{Flashcard is not viewable by user} 1355 1355 \item[Post-conditions]{Flashcard is not viewable by user}
1356 1356
\item[Trigger]{Card is flagged; Card is noted to be hidden} 1357 1357 \item[Trigger]{Card is flagged; Card is noted to be hidden}
1358 1358
\item[Workflow] 1359 1359 \item[Workflow]
1360 1360
\begin{enumerate} 1361 1361 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1362 1362 \itemsep1pt\parskip0pt\parsep0pt
\item 1363 1363 \item
{The User chooses a class from the dashboard.} 1364 1364 {The User chooses a class from the dashboard.}
\item 1365 1365 \item
{The Client shows the Live Feed for the selected class.} 1366 1366 {The Client shows the Live Feed for the selected class.}
\item 1367 1367 \item
{The User sees a card they want to hide from the Live Feed.} 1368 1368 {The User sees a card they want to hide from the Live Feed.}
\item 1369 1369 \item
{The User shall press a ``Hide Flashcard'' button on the card to be 1370 1370 {The User shall press a ``Hide Flashcard'' button on the card to be
hidden.} 1371 1371 hidden.}
\item 1372 1372 \item
{The Client shall hide the card of interest from the Live Feed, for 1373 1373 {The Client shall hide the card of interest from the Live Feed, for
only that User.} 1374 1374 only that User.}
\end{enumerate} 1375 1375 \end{enumerate}
1376 1376
\end{description} 1377 1377 \end{description}
1378 1378
\newpage 1379 1379 \newpage
1380 1380
{} 1381 1381 {}
1382 1382
\subsection{{{{[}F9{]} View a 1383 1383 \subsection{{{{[}F9{]} View a
Feed}}{{[}F9{]} View a Feed}} 1384 1384 Feed}}{{[}F9{]} View a Feed}}
1385 1385
\begin{description} 1386 1386 \begin{description}
\item[Description]{The user shall be able to view Live Feeds for different 1387 1387 \item[Description]{The user shall be able to view Live Feeds for different
classes} 1388 1388 classes}
1389 1389
\item[Desired Outcome]{The system shall only show the user Live Feeds for 1390 1390 \item[Desired Outcome]{The system shall only show the user Live Feeds for
specific classes. } 1391 1391 specific classes. }
\\ 1392 1392 \\
\item[User Goals]{The user will see only one Live Feed at a time. } 1393 1393 \item[User Goals]{The user will see only one Live Feed at a time. }
1394 1394
\item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User 1395 1395 \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 1396 1396 Login, {[}A3{]} Add a Class}
\\ 1397 1397 \\
\item[Priority Level]{``Must''} 1398 1398 \item[Priority Level]{``Must''}
1399 1399
{Status:}{Not implemented} 1400 1400 {Status:}{Not implemented}
1401 1401
\item[Pre-conditions]{User has added a class} 1402 1402 \item[Pre-conditions]{User has added a class}
1403 1403
\item[Post-conditions]{User shall see the Live Feed for that class} 1404 1404 \item[Post-conditions]{User shall see the Live Feed for that class}
1405 1405
\item[Trigger]{User shall select a class} 1406 1406 \item[Trigger]{User shall select a class}
1407 1407
\item[Workflow] 1408 1408 \item[Workflow]
1409 1409
\begin{enumerate} 1410 1410 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1411 1411 \itemsep1pt\parskip0pt\parsep0pt
\item 1412 1412 \item
{The User logs into their account.} 1413 1413 {The User logs into their account.}
\item 1414 1414 \item
{The System verifies the User's credentials and saves their session.} 1415 1415 {The System verifies the User's credentials and saves their session.}
\item 1416 1416 \item
{The User is at their dashboard.} 1417 1417 {The User is at their dashboard.}
\item 1418 1418 \item
{The Client shows the User's dashboard.} 1419 1419 {The Client shows the User's dashboard.}
\item 1420 1420 \item
{The User selects a class from their dashboard.} 1421 1421 {The User selects a class from their dashboard.}
\item 1422 1422 \item
{The Client displays the Live Feed for the class.} 1423 1423 {The Client displays the Live Feed for the class.}
\end{enumerate} 1424 1424 \end{enumerate}
1425 1425
\end{description} 1426 1426 \end{description}
\newpage 1427 1427 \newpage
1428 1428
{} 1429 1429 {}
\section{Decks} 1430 1430 \section{Decks}
\subsection{{{{[}-D2-{]} Making a 1431 1431 \subsection{{{{[}-D2-{]} Making a
deck}}{{[}-D2-{]} Making a deck}} 1432 1432 deck}}{{[}-D2-{]} Making a deck}}
1433 1433
\begin{description} 1434 1434 \begin{description}
\item[Description]{Upon selecting the right course, the student has the 1435 1435 \item[Description]{Upon selecting the right course, the student has the
power to make a deck by either selecting existing flashcard or adding a 1436 1436 power to make a deck by either selecting existing flashcard or adding a
new flashcard.} 1437 1437 new flashcard.}
1438 1438
\item[Desired Outcome]{The user can keep track of cards that s/he wants.} 1439 1439 \item[Desired Outcome]{The user can keep track of cards that s/he wants.}
\\ 1440 1440 \\
\item[User Goals]{The user has a personal deck ready for review later.} 1441 1441 \item[User Goals]{The user has a personal deck ready for review later.}
1442 1442
\item[Primary Actor]{User (student)} 1443 1443 \item[Primary Actor]{User (student)}
1444 1444
\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck 1445 1445 \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
{[}F1{]}, Make a Flashcard {[}F3{]}} 1446 1446 {[}F1{]}, Make a Flashcard {[}F3{]}}
\\ 1447 1447 \\
\item[Priority Level]{``Must''} 1448 1448 \item[Priority Level]{``Must''}
1449 1449
\item[Status]{In Progress} 1450 1450 \item[Status]{In Progress}
1451 1451
\item[Pre-conditions] 1452 1452 \item[Pre-conditions]
1453 1453
\begin{itemize} 1454 1454 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1455 1455 \itemsep1pt\parskip0pt\parsep0pt
\item 1456 1456 \item
{The user has an account with the application. } 1457 1457 {The user has an account with the application. }
\item 1458 1458 \item
{The user has been added to the desired class.} 1459 1459 {The user has been added to the desired class.}
\end{itemize} 1460 1460 \end{itemize}
1461 1461
\item[Post-conditions] 1462 1462 \item[Post-conditions]
1463 1463
\begin{itemize} 1464 1464 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1465 1465 \itemsep1pt\parskip0pt\parsep0pt
\item 1466 1466 \item
{Desired cards are added to user's deck to the specific class } 1467 1467 {Desired cards are added to user's deck to the specific class }
\item 1468 1468 \item
{User's deck is added to the database.} 1469 1469 {User's deck is added to the database.}
\end{itemize} 1470 1470 \end{itemize}
1471 1471
\item[Trigger]{User has selected a card from the pool. User submitted a 1472 1472 \item[Trigger]{User has selected a card from the pool. User submitted a
new flashcard after ``Make New Flashcard''.} 1473 1473 new flashcard after ``Make New Flashcard''.}
1474 1474
\item[Workflow] 1475 1475 \item[Workflow]
1476 1476
\begin{enumerate} 1477 1477 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1478 1478 \itemsep1pt\parskip0pt\parsep0pt
\item 1479 1479 \item
{User is at their dashboard.} 1480 1480 {User is at their dashboard.}
\item 1481 1481 \item
{User selects the class of interest that they had no activity in yet.} 1482 1482 {User selects the class of interest that they had no activity in yet.}
\item 1483 1483 \item
{Client displays the Live Feed for the class.} 1484 1484 {Client displays the Live Feed for the class.}
\item 1485 1485 \item
{User presses ``Pull Flashcard'' button on a Flashcard that they want 1486 1486 {User presses ``Pull Flashcard'' button on a Flashcard that they want
in their Deck.} 1487 1487 in their Deck.}
\item 1488 1488 \item
{The server creates a Deck for the User for the Class of interest.} 1489 1489 {The server creates a Deck for the User for the Class of interest.}
\item 1490 1490 \item
{The server adds the Flashcard to the User's Deck.} 1491 1491 {The server adds the Flashcard to the User's Deck.}
\item 1492 1492 \item
{The Client makes the Flashcard disappear from the Live Feed.} 1493 1493 {The Client makes the Flashcard disappear from the Live Feed.}
\item 1494 1494 \item
{The Client displays the Flashcard in the User's Deck in the sidebar.} 1495 1495 {The Client displays the Flashcard in the User's Deck in the sidebar.}
\end{enumerate} 1496 1496 \end{enumerate}
1497 1497
{Alternate Workflow:} 1498 1498 {Alternate Workflow:}
1499 1499
\begin{enumerate} 1500 1500 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1501 1501 \itemsep1pt\parskip0pt\parsep0pt
\item 1502 1502 \item
{User is at their dashboard.} 1503 1503 {User is at their dashboard.}
\item 1504 1504 \item
{User selects the class of interest that they had no activity in yet.} 1505 1505 {User selects the class of interest that they had no activity in yet.}
\item 1506 1506 \item
{Client displays the Live Feed for the class.} 1507 1507 {Client displays the Live Feed for the class.}
\item 1508 1508 \item
{The User adds a Flashcard into the Class.} 1509 1509 {The User adds a Flashcard into the Class.}
\item 1510 1510 \item
{The server creates a Deck for the User for the Class of interest.} 1511 1511 {The server creates a Deck for the User for the Class of interest.}
\item 1512 1512 \item
{The server adds the new Flashcard to the User's Deck.} 1513 1513 {The server adds the new Flashcard to the User's Deck.}
\item 1514 1514 \item
{The Client makes the Flashcard disappear from the Live Feed.} 1515 1515 {The Client makes the Flashcard disappear from the Live Feed.}
\item 1516 1516 \item
{The Client displays the Flashcard in the User's Deck in the sidebar.} 1517 1517 {The Client displays the Flashcard in the User's Deck in the sidebar.}
\end{enumerate} 1518 1518 \end{enumerate}
\end{description} 1519 1519 \end{description}
\newpage 1520 1520 \newpage
1521 1521
{} 1522 1522 {}
1523 1523
\subsection{{{{[}D1{]} Remove a card from a 1524 1524 \subsection{{{{[}D1{]} Remove a card from a
deck}}{{[}D1{]} Remove a card from a deck}} 1525 1525 deck}}{{[}D1{]} Remove a card from a deck}}
1526 1526
\begin{description} 1527 1527 \begin{description}
\item[Description]{The user can remove flashcards from their deck.} 1528 1528 \item[Description]{The user can remove flashcards from their deck.}
1529 1529
\item[Desired Outcome]{The user will not be notified about that card. } 1530 1530 \item[Desired Outcome]{The user will not be notified about that card. }
\\ 1531 1531 \\
\item[User Goals]{To only review cards that the user wants to review. } 1532 1532 \item[User Goals]{To only review cards that the user wants to review. }
1533 1533
\item[Primary Actor]{User (student)} 1534 1534 \item[Primary Actor]{User (student)}
1535 1535
\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck 1536 1536 \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
{[}F1{]}, Make a Flashcard {[}F3{]}} 1537 1537 {[}F1{]}, Make a Flashcard {[}F3{]}}
\\ 1538 1538 \\
\item[Priority Level]{``Must''} 1539 1539 \item[Priority Level]{``Must''}
1540 1540
\item[Status]{Unimplemented} 1541 1541 \item[Status]{Unimplemented}
1542 1542
\item[Pre-conditions] 1543 1543 \item[Pre-conditions]
1544 1544
\begin{itemize} 1545 1545 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1546 1546 \itemsep1pt\parskip0pt\parsep0pt
\item 1547 1547 \item
{The User has an account with the application} 1548 1548 {The User has an account with the application}
\item 1549 1549 \item
{The User is logged in} 1550 1550 {The User is logged in}
\end{itemize} 1551 1551 \end{itemize}
1552 1552
\item[Post-conditions] 1553 1553 \item[Post-conditions]
1554 1554
\begin{itemize} 1555 1555 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1556 1556 \itemsep1pt\parskip0pt\parsep0pt
\item 1557 1557 \item
{Desired cards are hidden to the user.} 1558 1558 {Desired cards are hidden to the user.}
\end{itemize} 1559 1559 \end{itemize}
1560 1560
\item[Trigger]{User has selected a card to be hidden.} 1561 1561 \item[Trigger]{User has selected a card to be hidden.}
1562 1562
\item[Workflow] 1563 1563 \item[Workflow]
1564 1564
\begin{enumerate} 1565 1565 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1566 1566 \itemsep1pt\parskip0pt\parsep0pt
\item 1567 1567 \item
{The Client shows the user the dashboard.} 1568 1568 {The Client shows the user the dashboard.}
\item 1569 1569 \item
{The User shall select the appropriate class.} 1570 1570 {The User shall select the appropriate class.}
\item 1571 1571 \item
{The System checks if the class is in session.} 1572 1572 {The System checks if the class is in session.}
\item 1573 1573 \item
{The User shall select deck view.} 1574 1574 {The User shall select deck view.}
\item 1575 1575 \item
{The Client shall route the user to the deck view.} 1576 1576 {The Client shall route the user to the deck view.}
\item 1577 1577 \item
{The User clicks a flashcard's remove button.} 1578 1578 {The User clicks a flashcard's remove button.}
\item 1579 1579 \item
{The Client shall send a DELETE request to the server}{}{at 1580 1580 {The Client shall send a DELETE request to the server}{}{at
/api/flashcard/\textless{}flashcard ID\textgreater{}/remove} 1581 1581 /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
\item 1582 1582 \item
{The Server removes the flashcard from the User's Deck.} 1583 1583 {The Server removes the flashcard from the User's Deck.}
\item 1584 1584 \item
{The Server updates the flashcard's position in the Live Feed.} 1585 1585 {The Server updates the flashcard's position in the Live Feed.}
\item 1586 1586 \item
{The Client updates the User's Deck.} 1587 1587 {The Client updates the User's Deck.}
\end{enumerate} 1588 1588 \end{enumerate}
1589 1589
{} 1590 1590 {}
1591 1591
{Alternate Workflow:} 1592 1592 {Alternate Workflow:}
1593 1593
\begin{enumerate} 1594 1594 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1595 1595 \itemsep1pt\parskip0pt\parsep0pt
\item 1596 1596 \item
{The Client shows the user the dashboard.} 1597 1597 {The Client shows the user the dashboard.}
\item 1598 1598 \item
{The User shall select the appropriate class.} 1599 1599 {The User shall select the appropriate class.}
\item 1600 1600 \item
{The System checks if the class is }{not}{in session.} 1601 1601 {The System checks if the class is }{not}{in session.}
\item 1602 1602 \item
{The Client shall the user to the deck view.} 1603 1603 {The Client shall the user to the deck view.}
\item 1604 1604 \item
{The User clicks a flashcard's remove button.} 1605 1605 {The User clicks a flashcard's remove button.}
\item 1606 1606 \item
{The Client shall send a DELETE request to the server}{}{at 1607 1607 {The Client shall send a DELETE request to the server}{}{at
/api/flashcard/\textless{}flashcard ID\textgreater{}/remove} 1608 1608 /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
\item 1609 1609 \item
{The Server removes the flashcard from the User's Deck.} 1610 1610 {The Server removes the flashcard from the User's Deck.}
\item 1611 1611 \item
{The Server updates the flashcard's position in the Live Feed.} 1612 1612 {The Server updates the flashcard's position in the Live Feed.}
\item 1613 1613 \item
{The Client updates the User's Deck.} 1614 1614 {The Client updates the User's Deck.}
\end{enumerate} 1615 1615 \end{enumerate}
\end{description} 1616 1616 \end{description}
1617 1617
\subsection{{{{[}-D2-{]} Shuffling 1618 1618 \subsection{{{{[}-D2-{]} Shuffling
deck}}{{[}-D2-{]} Shuffling deck}} 1619 1619 deck}}{{[}-D2-{]} Shuffling deck}}
1620 1620
\begin{description} 1621 1621 \begin{description}
\item[Description]{User is able to shuffle his/her deck as a way to study 1622 1622 \item[Description]{User is able to shuffle his/her deck as a way to study
the flashcards} 1623 1623 the flashcards}
1624 1624
\item[Desired Outcome]{When taking a quiz, the user will notice that 1625 1625 \item[Desired Outcome]{When taking a quiz, the user will notice that
flashcards appear in random order} 1626 1626 flashcards appear in random order}