Commit 88a4cb271633308e3530f1c36d9d9d970f728ab8
1 parent
9aa122a9e7
Exists in
master
Added F5. May split them into two cases
Showing 1 changed file with 31 additions and 31 deletions Side-by-side Diff
DesignUseCases.tex
View file @
88a4cb2
| ... | ... | @@ -957,7 +957,7 @@ |
| 957 | 957 | \item[Desired Outcome]{The flashcard's inappropriateness variable is |
| 958 | 958 | adjusted.} |
| 959 | 959 | \\ |
| 960 | -\item[User Goals]{To note if a card should not belong in the class and | |
| 960 | +\item[User Goals]{To notify the admins if a card is inappropriate and | |
| 961 | 961 | should not be displayed in the feed.} |
| 962 | 962 | |
| 963 | 963 | \item[Primary Actor]{User (Student)} |
| 964 | 964 | |
| 965 | 965 | |
| 966 | 966 | |
| ... | ... | @@ -974,17 +974,13 @@ |
| 974 | 974 | \begin{itemize} |
| 975 | 975 | \itemsep1pt\parskip0pt\parsep0pt |
| 976 | 976 | \item |
| 977 | - {User is enrolled in a class} | |
| 978 | -\end{itemize} | |
| 979 | - | |
| 980 | -\begin{itemize} | |
| 981 | -\itemsep1pt\parskip0pt\parsep0pt | |
| 977 | + {The user is enrolled in a class} | |
| 982 | 978 | \item |
| 983 | - {Flashcard is created.} | |
| 979 | + {The flashcard has been created.} | |
| 984 | 980 | \item |
| 985 | - {Flashcard is viewable in feed.} | |
| 981 | + {The flashcard is viewable in feed.} | |
| 986 | 982 | \item |
| 987 | - {The User has clicked the red button on the flashcard which is the "Hide Card" button.} | |
| 983 | + {The user has clicked the red 'eye' icon on the flashcard which is the "Hide Card" button.} | |
| 988 | 984 | \end{itemize} |
| 989 | 985 | |
| 990 | 986 | \item[Post-conditions] |
| ... | ... | @@ -994,7 +990,7 @@ |
| 994 | 990 | \item |
| 995 | 991 | {Flashcard is hidden from user.} |
| 996 | 992 | \item |
| 997 | - {Flashcard internal variable is adjusted.} | |
| 993 | + {The flashcard is marked as being inappropriate.} | |
| 998 | 994 | \end{itemize} |
| 999 | 995 | |
| 1000 | 996 | \item[Trigger]{The User does not like the particular flashcard.} |
| 1001 | 997 | |
| 1002 | 998 | |
| 1003 | 999 | |
| 1004 | 1000 | |
| ... | ... | @@ -1003,15 +999,18 @@ |
| 1003 | 999 | |
| 1004 | 1000 | \begin{enumerate} |
| 1005 | 1001 | \itemsep1pt\parskip0pt\parsep0pt |
| 1006 | -\item { | |
| 1007 | - The frontend displays a toast that offers the User the report text.} | |
| 1008 | 1002 | \item |
| 1009 | - {The User clicks the ``Report'' text on the flashcard.} | |
| 1003 | + {The frontend displays a toast that offers the user the report text.} | |
| 1010 | 1004 | \item |
| 1011 | - {The frontend shall hide the flashcard from the User.} | |
| 1005 | + {The user clicks the ``Report'' text on the flashcard.} | |
| 1012 | 1006 | \item |
| 1013 | - {The backend shall check if the User already hid the flashcard in views.py function report.} | |
| 1007 | + {The frontend shall hide the flashcard from the user in FlashcardFactory.js.} | |
| 1014 | 1008 | \item |
| 1009 | + {The frontend shall generate a POST request in Flashcard.report in FlashcardFactory.js | |
| 1010 | + and send it to /api/flashcards/\textless{}flashcard id \textgreater{}/report} | |
| 1011 | +\item | |
| 1012 | + {The backend shall check if the user already hid the flashcard in views.py function report.} | |
| 1013 | +\item | |
| 1015 | 1014 | {The backend shall hide the flashcard in models.py in class FlashcardHide. } |
| 1016 | 1015 | \end{enumerate} |
| 1017 | 1016 | \end{description} |
| 1018 | 1017 | |
| 1019 | 1018 | |
| 1020 | 1019 | |
| 1021 | 1020 | |
| ... | ... | @@ -1023,18 +1022,18 @@ |
| 1023 | 1022 | |
| 1024 | 1023 | {} |
| 1025 | 1024 | |
| 1026 | -\subsection{[F5] Filter Flashcards - Deferred} | |
| 1025 | +\subsection{[F5] Filter Flashcards} | |
| 1027 | 1026 | |
| 1028 | 1027 | \begin{description} |
| 1029 | -\item[Description]{The User is able to filter for flashcards by date.} | |
| 1028 | +\item[Description]{The user is able to filter for flashcards by material date and text.} | |
| 1030 | 1029 | |
| 1031 | -\item[Desired Outcome]{The User shall see flashcards based on the filter | |
| 1032 | -options.} | |
| 1030 | +\item[Desired Outcome]{The user shall see flashcards based on the filter | |
| 1031 | +options: the material date and the text of the card.} | |
| 1033 | 1032 | |
| 1034 | -{User Goals:}{The User can find what he/she is specifically looking | |
| 1033 | +{User Goals:}{The user can find what he/she is specifically looking | |
| 1035 | 1034 | for.} |
| 1036 | 1035 | |
| 1037 | -\item[Primary Actor]{User (student)} | |
| 1036 | +\item[Primary Actor]{User} | |
| 1038 | 1037 | |
| 1039 | 1038 | \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User |
| 1040 | 1039 | Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull |
| 1041 | 1040 | |
| 1042 | 1041 | |
| ... | ... | @@ -1042,18 +1041,16 @@ |
| 1042 | 1041 | \\ |
| 1043 | 1042 | \item[Priority Level]{''Should''} |
| 1044 | 1043 | |
| 1045 | -\item[Status]{Not Implemented } | |
| 1044 | +\item[Status]{Implemented } | |
| 1046 | 1045 | |
| 1047 | 1046 | \item[Pre-conditions] |
| 1048 | 1047 | |
| 1049 | 1048 | \begin{itemize} |
| 1050 | 1049 | \itemsep1pt\parskip0pt\parsep0pt |
| 1051 | 1050 | \item |
| 1052 | - {User has added the class.} | |
| 1051 | + {The user has added a class.} | |
| 1053 | 1052 | \item |
| 1054 | - {Flashcards exist in the course.} | |
| 1055 | -\item | |
| 1056 | - {The User has navigated to the study page.} | |
| 1053 | + {The class in question contains non-zero number of flashcards.} | |
| 1057 | 1054 | \end{itemize} |
| 1058 | 1055 | |
| 1059 | 1056 | \item[Post-conditions]{} |
| 1060 | 1057 | |
| 1061 | 1058 | |
| 1062 | 1059 | |
| 1063 | 1060 | |
| ... | ... | @@ -1061,21 +1058,24 @@ |
| 1061 | 1058 | \begin{itemize} |
| 1062 | 1059 | \itemsep1pt\parskip0pt\parsep0pt |
| 1063 | 1060 | \item |
| 1064 | - {User only sees specific flashcards} | |
| 1061 | + {The user only sees the flashcards that match his filter criterion.} | |
| 1065 | 1062 | \end{itemize} |
| 1066 | 1063 | |
| 1067 | -\item[Trigger]{The User wants to only see cards for a specific date range.} | |
| 1064 | +\item[Trigger]{The user wants to only see cards for a specific date range or with a specific substring in their text.} | |
| 1068 | 1065 | |
| 1069 | 1066 | \item[Workflow] |
| 1070 | 1067 | |
| 1071 | 1068 | \begin{enumerate} |
| 1072 | 1069 | \itemsep1pt\parskip0pt\parsep0pt |
| 1073 | 1070 | \item |
| 1074 | - {The frontend shall render the page described in study.html.} | |
| 1071 | + {The frontend shall render the page described in study.html using CardListController.js.} | |
| 1075 | 1072 | \item |
| 1076 | - {The User fills in the date fields.} | |
| 1073 | + {The user shall select the weeks that the filtered cards should belong to.} | |
| 1077 | 1074 | \item |
| 1078 | - {The frontend checks the date fields before making the POST request to /api/study.} | |
| 1075 | + {The user shall type in the appropriate search filter in the text input box on the top right of the screen.} | |
| 1076 | +\item | |
| 1077 | + {The frontend generates a POST request with the flashcard dates and the flashcard text filter as | |
| 1078 | + parameteres and sends it to /api/study.} | |
| 1079 | 1079 | \item |
| 1080 | 1080 | {The system follows the Study workflow, displaying only cards made within a certain date time.} |
| 1081 | 1081 |