110swag / docs

Compare View

switch
from
...
to
 
Commits (2)

Diff

Showing 1 changed file Side-by-side Diff

DesignUseCases.tex View file @ 8e2284f
... ... @@ -1510,17 +1510,17 @@ order.}
1510 1510 \subsection{[R1] Study Deck}
1511 1511  
1512 1512 \begin{description}
1513   -\item[Description]{The User shall be able to look at the cards in his/her
  1513 +\item[Description]{The user shall be able to look at the cards in his/her
1514 1514 deck in order to study them}
1515 1515  
1516   -\item[Desired Outcome]{The User shall be presented with individual
  1516 +\item[Desired Outcome]{The user shall be presented with individual
1517 1517 flashcards in an optimized order. Blanks will be empty and the user will
1518 1518 have a text boxes to fill in.}
1519 1519 \\
1520   -\item[User Goals]{The user shall be able to study all flashcards in his/her
  1520 +\item[user Goals]{The user shall be able to study all flashcards in his/her
1521 1521 deck from the appropriate class.}
1522 1522  
1523   -\item[Primary Actor]{User (student)}
  1523 +\item[Primary Actor]{user (student)}
1524 1524  
1525 1525 \item[Dependency Use Cases]{{[}F1{]}}
1526 1526 \\
... ... @@ -1533,9 +1533,9 @@ deck from the appropriate class.}
1533 1533 \begin{itemize}
1534 1534 \itemsep1pt\parskip0pt\parsep0pt
1535 1535 \item
1536   - {User is logged in}
  1536 + {user is logged in}
1537 1537 \item
1538   - {User has added cards to his/her deck}
  1538 + {user has added cards to his/her deck}
1539 1539 \end{itemize}
1540 1540  
1541 1541 \item[Post-conditions]{}
... ... @@ -1543,51 +1543,81 @@ deck from the appropriate class.}
1543 1543 \begin{itemize}
1544 1544 \itemsep1pt\parskip0pt\parsep0pt
1545 1545 \item
1546   - {User shall see a single card with blanks.}
  1546 + {user shall see a single card with blanks.}
1547 1547 \end{itemize}
1548 1548  
1549 1549 \begin{itemize}
1550 1550 \itemsep1pt\parskip0pt\parsep0pt
1551 1551 \item
1552   - {User shall be presented with text boxes to fill in}
  1552 + {user shall be presented with text boxes to fill in}
1553 1553 \end{itemize}
1554 1554  
1555   -\item[Trigger]{User wishes to study flashcards compiled for a specific class.}
  1555 +\item[Trigger]{user wishes to study flashcards compiled for a specific class.}
1556 1556  
1557   -\item[Workflow]
  1557 +\item[Workflow - Blanked]
1558 1558  
1559 1559 \begin{enumerate}
1560 1560 \itemsep1pt\parskip0pt\parsep0pt
1561 1561 \item
1562   - {The User shall view a class.}
  1562 + {The user shall view a class.}
  1563 +\item
  1564 + {The user shall click on the button ``Study Deck''.}
1563 1565 \item
1564   - {The User shall click on the button ``Study Deck''.}
  1566 + {The frontend shall display study.html to the user.}
1565 1567 \item
1566   - {The Client shall send POST request to the Server for a flashcard (ordering
1567   - based on a hidden algorithm).}
  1568 + {The user shall select which classes he/she would like to study.}
1568 1569 \item
1569   - {The Client shall display the Study View to the User with blanks to fill in.}
  1570 + {The user shall click on the button ``Fetch'' to begin studying.}
1570 1571 \item
1571   - {The User shall fill in the blanks.}
  1572 + {The frontend shall send POST request to the UserFlashcardQuizViewSet in views.py
  1573 + for a flashcard (ordering based on a hidden algorithm).}
1572 1574 \item
1573   - {The Client shall send the User's response back to the Server in POST.}
  1575 + {The user shall enter a response for the flashcard.}
1574 1576 \item
1575   - {The Server shall inform the Client of how correct the User's repsonse was.}
  1577 + {The frontend shall send the user's response back to the backend in POST.}
1576 1578 \item
1577   - {The Client shall display said results to User.}
  1579 + {The backend shall inform the frontend of how correct the user's repsonse was.}
1578 1580 \item
1579   - {The Client shall produce two buttons for the User, indicating whether or
  1581 + {The frontend shall display said results to user.}
  1582 +\item
  1583 + {The frontend shall produce two buttons for the user, indicating whether or
1580 1584 not the card was answered correctly based on the provided results.}
1581 1585 \item
1582   - {The User shall select their desired response.}
  1586 + {The user shall select their desired response.}
1583 1587 \item
1584   - {The Client shall relay response to server in a POST request.}
  1588 + {The frontend shall relay response to the backend in a POST request.}
1585 1589 \item
1586   - {The Server saves the response and updates statistics about the
  1590 + {The backend saves the response and updates statistics about the
1587 1591 flashcard.}
1588 1592 \item
1589   - {Loop back to 3.}
  1593 + {Loop back to 6.}
1590 1594 \end{enumerate}
  1595 +
  1596 +[Alternative Workflow - No Blanks]
  1597 +
  1598 +\begin{enumerate}
  1599 +\itemsep1pt\parskip0pt\parsep0pt
  1600 +\item
  1601 + {The user shall view a class.}
  1602 +\item
  1603 + {The user shall click on the button ``Study Deck''.}
  1604 +\item
  1605 + {The frontend shall display study.html to the user.}
  1606 +\item
  1607 + {The user shall select which classes he/she would like to study.}
  1608 +\item
  1609 + {The user shall click on the button ``Fetch'' to begin studying.}
  1610 +\item
  1611 + {The frontend shall send POST request to the UserFlashcardQuizViewSet in views.py
  1612 + for a flashcard (ordering based on a hidden algorithm).}
  1613 +\item
  1614 + {The backend shall inform the frontend that this card had no blanks.}
  1615 +\item
  1616 + {The user shall click on the button ``Next'' to retrieve the next card.}
  1617 +\item
  1618 + {Loop back to 6.}
  1619 +\end{enumerate}
  1620 +
1591 1621 \end{description}
1592 1622 \newpage
1593 1623