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