Commit 236734468e05aee26133690d6866ddd63984f732
1 parent
b7134f4341
Exists in
master
design use cases
Showing 1 changed file with 22 additions and 67 deletions Side-by-side Diff
DesignUseCases.tex
View file @
2367344
| ... | ... | @@ -730,13 +730,13 @@ |
| 730 | 730 | \subsection{[F1] Push Flashcard} |
| 731 | 731 | |
| 732 | 732 | \begin{description} |
| 733 | -\item[Description]{The user shall be able to create a flashcard with their | |
| 733 | +\item[Description]{The User shall be able to create a flashcard with their | |
| 734 | 734 | input. } |
| 735 | 735 | |
| 736 | -\item[Desired Outcome]{The user shall have the flashcard added to their own | |
| 736 | +\item[Desired Outcome]{The User shall have the flashcard added to their own | |
| 737 | 737 | deck and the Live Feed. } |
| 738 | 738 | \\ |
| 739 | -\item[User Goals]{The user will see their flashcard in their deck and the | |
| 739 | +\item[User Goals]{The User will see their flashcard in their deck and the | |
| 740 | 740 | flashcard will be shared with others. } |
| 741 | 741 | |
| 742 | 742 | \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User |
| 743 | 743 | |
| 744 | 744 | |
| ... | ... | @@ -747,11 +747,11 @@ |
| 747 | 747 | \begin{itemize} |
| 748 | 748 | \itemsep1pt\parskip0pt\parsep0pt |
| 749 | 749 | \item |
| 750 | - {The User has an account } | |
| 750 | + {The User has an account.} | |
| 751 | 751 | \item |
| 752 | - {The User has added at least one class} | |
| 752 | + {The User has added at least one class.} | |
| 753 | 753 | \item |
| 754 | - {The User is on the class' page} | |
| 754 | + {The User has navigated to the live feed for a class.} | |
| 755 | 755 | \end{itemize} |
| 756 | 756 | |
| 757 | 757 | \item[Post-conditions] |
| 758 | 758 | |
| 759 | 759 | |
| 760 | 760 | |
| 761 | 761 | |
| 762 | 762 | |
| 763 | 763 | |
| 764 | 764 | |
| 765 | 765 | |
| 766 | 766 | |
| 767 | 767 | |
| 768 | 768 | |
| 769 | 769 | |
| 770 | 770 | |
| 771 | 771 | |
| 772 | 772 | |
| ... | ... | @@ -759,89 +759,44 @@ |
| 759 | 759 | \begin{itemize} |
| 760 | 760 | \itemsep1pt\parskip0pt\parsep0pt |
| 761 | 761 | \item |
| 762 | - {The User has flashcard added to their deck} | |
| 762 | + {The User has flashcard added to their deck.} | |
| 763 | 763 | \item |
| 764 | - {The Flashcard is shown in the Live Feed} | |
| 764 | + {The Flashcard is shown in the Live Feed.} | |
| 765 | 765 | \item |
| 766 | - {Other users can add this flashcard to their decks} | |
| 766 | + {Other users can add this flashcard to their decks.} | |
| 767 | 767 | \end{itemize} |
| 768 | 768 | |
| 769 | -\item[Trigger]{} | |
| 769 | +\item[Trigger]{The User wants to make a flashcard to study.} | |
| 770 | 770 | |
| 771 | -\begin{itemize} | |
| 772 | -\itemsep1pt\parskip0pt\parsep0pt | |
| 773 | -\item | |
| 774 | - {The User has clicked on the button ``Make New Flashcard''.} | |
| 775 | -\item | |
| 776 | - {The Server receives a POST request containing the flashcard data.} | |
| 777 | -\end{itemize} | |
| 778 | - | |
| 779 | 771 | \item[Workflow] |
| 780 | 772 | |
| 781 | 773 | \begin{enumerate} |
| 782 | 774 | \itemsep1pt\parskip0pt\parsep0pt |
| 783 | 775 | \item |
| 784 | - {The User is at the live feed for the class.} | |
| 776 | + {The User is at the live feed for the class from feed.html.} | |
| 785 | 777 | \item |
| 786 | - {The User shall click on the button}{Push | |
| 787 | - Flashcard} | |
| 778 | + {The User shall click on the 'Plus' button or press the hotkey 'c'.} | |
| 788 | 779 | \item |
| 789 | - {The | |
| 790 | - }{Client}{shall | |
| 791 | - present a dialog box for inputting the flashcard text to the User.} | |
| 780 | + {The frontend shall present a modal for inputting the flashcard text to the User.} | |
| 792 | 781 | \item |
| 793 | - {The User shall input the flashcard text.} | |
| 782 | + {The User shall type in the content of their flashcard.} | |
| 794 | 783 | \item |
| 795 | - {Optionally, the User shall mark keywords in the flashcard text.} | |
| 784 | + {The User shall highlight keywords in the flashcard text.} | |
| 796 | 785 | \item |
| 797 | - {If the User creates this flashcard outside of the lecture time, he | |
| 798 | - will get the option to change the material date.} | |
| 799 | -\item | |
| 800 | - {The User shall click on the `Submit' button to submit the flashcard | |
| 786 | + {The User shall click on the `Contribute' button to submit the flashcard | |
| 801 | 787 | text, blanks, and material date, in JSON form as a POST request.} |
| 802 | 788 | \item |
| 803 | - {The Server shall obtain the flashcard information by deserializing | |
| 804 | - the JSON in the POST request.} | |
| 789 | + {The backend shall obtain the flashcard information by deserializing | |
| 790 | + the JSON in the POST request in views.py.} | |
| 805 | 791 | \item |
| 806 | - {The Server shall create a new record for this flashcard in the | |
| 807 | - Flashcards table in the database.} | |
| 792 | + {The backend shall create a new record for this flashcard in the | |
| 793 | + Flashcards table in the database in models.py.} | |
| 808 | 794 | \item |
| 809 | - {The Server shall publish the newly created card to the live feed of | |
| 810 | - the class.} | |
| 795 | + {The frontend shall publish the newly created card to the live feed of | |
| 796 | + the class using FeedController.js.} | |
| 811 | 797 | \end{enumerate} |
| 812 | 798 | \end{description} |
| 813 | -{Alternative Workflow:} | |
| 814 | - | |
| 815 | -\begin{enumerate} | |
| 816 | -\itemsep1pt\parskip0pt\parsep0pt | |
| 817 | -\item | |
| 818 | - {The User shall view a flashcard that he/she did not create} | |
| 819 | -\item | |
| 820 | - {The User shall click ``Edit''} | |
| 821 | -\item | |
| 822 | - {The client shall present a dialog box for editing the existing | |
| 823 | - flashcard text} | |
| 824 | -\item | |
| 825 | - {The User shall make edits} | |
| 826 | -\item | |
| 827 | - {The User shall click ``save''} | |
| 828 | -\item | |
| 829 | - {The client shall send a POST request} | |
| 830 | -\item | |
| 831 | - {The server shall remove the original card from user's deck} | |
| 832 | -\item | |
| 833 | - {The Server shall obtain the flashcard information by deserializing | |
| 834 | - the JSON in the POST request.} | |
| 835 | -\item | |
| 836 | - {The Server shall create a new record for this flashcard in the | |
| 837 | - Flashcards table in the database.} | |
| 838 | -\item | |
| 839 | - {The Server shall publish the newly created card to the live feed of | |
| 840 | - the class.} | |
| 841 | -\end{enumerate} | |
| 842 | - | |
| 843 | 799 | \newpage |
| 844 | - | |
| 845 | 800 | {} |
| 846 | 801 | |
| 847 | 802 | \subsection{[F2] Edit Flashcard} |