110swag / docs

Compare View

switch
from
...
to
 
Commits (4)

Diff

Showing 2 changed files Inline Diff

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