Commit 600135c038036ca21776bf65ee3c06db7a79d379
Exists in
master
Merge branch 'master' of https://git.ucsd.edu/110swag/docs
Showing 3 changed files Side-by-side Diff
DesignUseCases.tex
View file @
600135c
... | ... | @@ -803,12 +803,11 @@ |
803 | 803 | \subsection{[F2] Edit Flashcard} |
804 | 804 | |
805 | 805 | \begin{description} |
806 | -\item[Description]{The User shall be able to edit the text on their own | |
807 | -flashcard } | |
806 | +\item[Description]{The User shall be able to duplicate the flashcard authored by a different user and make changes to it.} | |
808 | 807 | |
809 | -\item[Desired Outcome]{Flashcard is edited and saved appropriately.} | |
808 | +\item[Desired Outcome]{The new flashcard is edited and saved appropriately.} | |
810 | 809 | \\ |
811 | -\item[User Goals]{To be able to change text on a flashcard.} | |
810 | +\item[User Goals]{To create a flashcard similar to an existing flashcard but with minor changes.} | |
812 | 811 | |
813 | 812 | \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User |
814 | 813 | Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull |
815 | 814 | |
... | ... | @@ -819,11 +818,9 @@ |
819 | 818 | \begin{itemize} |
820 | 819 | \itemsep1pt\parskip0pt\parsep0pt |
821 | 820 | \item |
822 | - {Flashcard is created.} | |
821 | + {The flashcard to be edited is visible in the user's feed view or deck view.} | |
823 | 822 | \item |
824 | - {Flashcard in user's deck.} | |
825 | -\item | |
826 | - {Flashcard is viewable.} | |
823 | + {The user is currently in the feed view or the deck view of the course the card to be edited belongs to.} | |
827 | 824 | \end{itemize} |
828 | 825 | |
829 | 826 | \item[Post-conditions] |
830 | 827 | |
831 | 828 | |
832 | 829 | |
833 | 830 | |
834 | 831 | |
... | ... | @@ -831,25 +828,26 @@ |
831 | 828 | \begin{itemize} |
832 | 829 | \itemsep1pt\parskip0pt\parsep0pt |
833 | 830 | \item |
834 | - {Flashcard is edited.} | |
831 | + {A duplicate flashcard with some differences is created.} | |
835 | 832 | \end{itemize} |
836 | 833 | |
837 | -\item[Trigger] {The User wants to change a card to show different information.} | |
834 | +\item[Trigger] {The User wants to duplicate a card and make some changes to it and thus create a new flashcard.} | |
838 | 835 | \item[Workflow] |
839 | 836 | |
840 | 837 | \begin{enumerate} |
841 | 838 | \itemsep1pt\parskip0pt\parsep0pt |
842 | -\item{User has clicked ``Edit'' button when viewing a specific flashcard.} | |
839 | +\item{The user shall hover over the card to be edited and and click on the | |
840 | + pencil button that appears on the bottom left of the card.} | |
843 | 841 | \item |
844 | - {The frontend shall produce an editable dialog box containing flashcard | |
842 | + {The frontend shall produce an editable dialog box containing the flashcard | |
845 | 843 | text } |
846 | 844 | \item |
847 | 845 | {The user shall make desired changes} |
848 | 846 | \item |
849 | - {The user shall click `Save'} | |
847 | + {The user shall click `Save Changes'} | |
850 | 848 | \item |
851 | 849 | {The client shall generate a POST request for a new flashcard and send |
852 | - it to the server} | |
850 | + it to the server at /api/flashcards/} | |
853 | 851 | \item |
854 | 852 | {If the user changed only the blanks of the cards, the server shall |
855 | 853 | create a new FlashcardMask object and update the appropriate |
... | ... | @@ -1255,7 +1253,7 @@ |
1255 | 1253 | |
1256 | 1254 | {} |
1257 | 1255 | |
1258 | -\subsection{[F8] Hide cards from feed} | |
1256 | +\subsection{[F8] Hide Cards} | |
1259 | 1257 | |
1260 | 1258 | \begin{description} |
1261 | 1259 | \item[Description]{The user shall be able to hide cards from feed} |
1262 | 1260 | |
1263 | 1261 | |
1264 | 1262 | |
1265 | 1263 | |
1266 | 1264 | |
1267 | 1265 | |
1268 | 1266 | |
... | ... | @@ -1272,30 +1270,35 @@ |
1272 | 1270 | \\ |
1273 | 1271 | \item[Priority Level]{``Should''} |
1274 | 1272 | |
1275 | -{Status:}{Not implemented} | |
1273 | +{Status:}{Implemented} | |
1276 | 1274 | |
1277 | -\item[Pre-conditions]{Flashcard is created, flashcard is viewable by user} | |
1275 | +\item[Pre-conditions]{Flashcard is created, flashcard is viewable by user.} | |
1278 | 1276 | |
1279 | 1277 | \item[Post-conditions]{Flashcard is not viewable by user} |
1280 | 1278 | |
1281 | -\item[Trigger]{Card is flagged; Card is noted to be hidden} | |
1279 | +\item[Trigger]{The User no longer wants to see a card in their feed and deck.} | |
1282 | 1280 | |
1283 | 1281 | \item[Workflow] |
1284 | 1282 | |
1285 | 1283 | \begin{enumerate} |
1286 | 1284 | \itemsep1pt\parskip0pt\parsep0pt |
1287 | 1285 | \item |
1288 | - {The User chooses a class from the dashboard.} | |
1286 | + {The User chooses a class from the drop down menu.} | |
1289 | 1287 | \item |
1290 | - {The Client shows the Live Feed for the selected class.} | |
1288 | + {The frontend renders the Live Feed for the selected class from feed.html.} | |
1291 | 1289 | \item |
1292 | - {The User sees a card they want to hide from the Live Feed.} | |
1290 | + {The User sees a card they want to hide.} | |
1293 | 1291 | \item |
1294 | - {The User shall press a ``Hide Flashcard'' button on the card to be | |
1292 | + {The User shall press the ``Hide Flashcard'' button on the card to be | |
1295 | 1293 | hidden.} |
1296 | 1294 | \item |
1297 | - {The Client shall hide the card of interest from the Live Feed, for | |
1298 | - only that User.} | |
1295 | + {The frontend shall make a request to the backend from FeedController.js.} | |
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.} | |
1299 | 1302 | \end{enumerate} |
1300 | 1303 | |
1301 | 1304 | \end{description} |
1302 | 1305 | |
1303 | 1306 | |
1304 | 1307 | |
... | ... | @@ -1307,22 +1310,22 @@ |
1307 | 1310 | \subsection{[F9] View a Feed} |
1308 | 1311 | |
1309 | 1312 | \begin{description} |
1310 | -\item[Description]{The user shall be able to view Live Feeds for different | |
1313 | +\item[Description]{The User shall be able to view Live Feeds for different | |
1311 | 1314 | classes} |
1312 | 1315 | |
1313 | 1316 | \item[Desired Outcome]{The system shall only show the user Live Feeds for |
1314 | 1317 | specific classes. } |
1315 | 1318 | \\ |
1316 | -\item[User Goals]{The user will see only one Live Feed at a time. } | |
1319 | +\item[User Goals]{The User will see only one Live Feed at a time. } | |
1317 | 1320 | |
1318 | 1321 | \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User |
1319 | 1322 | Login, {[}A3{]} Add a Class} |
1320 | 1323 | \\ |
1321 | 1324 | \item[Priority Level]{``Must''} |
1322 | 1325 | |
1323 | -{Status:}{Not implemented} | |
1326 | +{Status:}{Implemented} | |
1324 | 1327 | |
1325 | -\item[Pre-conditions]{User has added a class} | |
1328 | +\item[Pre-conditions]{User has added a class.} | |
1326 | 1329 | |
1327 | 1330 | \item[Post-conditions]{User shall see the Live Feed for that class} |
1328 | 1331 | |
... | ... | @@ -1351,7 +1354,7 @@ |
1351 | 1354 | |
1352 | 1355 | {} |
1353 | 1356 | \section{Decks} |
1354 | -\subsection{[-D2-] Making a deck} | |
1357 | +\subsection{[-D2-] Making a deck - Removed} | |
1355 | 1358 | |
1356 | 1359 | \begin{description} |
1357 | 1360 | \item[Description]{Upon selecting the right course, the student has the |
... | ... | @@ -1459,7 +1462,7 @@ |
1459 | 1462 | \\ |
1460 | 1463 | \item[Priority Level]{``Must''} |
1461 | 1464 | |
1462 | -\item[Status]{Unimplemented} | |
1465 | +\item[Status]{Implemented} | |
1463 | 1466 | |
1464 | 1467 | \item[Pre-conditions] |
1465 | 1468 | |
... | ... | @@ -1536,7 +1539,7 @@ |
1536 | 1539 | \end{enumerate} |
1537 | 1540 | \end{description} |
1538 | 1541 | |
1539 | -\subsection{[-D2-] Shuffling deck} | |
1542 | +\subsection{[-D2-] Shuffling deck - Removed} | |
1540 | 1543 | |
1541 | 1544 | \begin{description} |
1542 | 1545 | \item[Description]{User is able to shuffle his/her deck as a way to study |
Makefile
View file @
600135c
1 | 1 | PNGS = built/use_cases_diagram.png built/schema_diagram.png built/schema_graph.png |
2 | -PDFS = built/DesignUseCases.pdf built/screen_sequence_diagram.pdf built/TestCases.pdf built/StoriesAndAcceptanceTests.pdf | |
2 | +PDFS = built/DesignUseCases.pdf built/screen_sequence_diagram.pdf built/TestCases.pdf built/StoriesAndAcceptanceTests.pdf built/UserStories.pdf | |
3 | 3 | |
4 | 4 | SCREEN_SEQUENCE_DOTS = $(wildcard screen_sequence_diagrams/*.dot) |
5 | 5 | SCREEN_SEQUENCE_PNGS = $(patsubst screen_sequence_diagrams/%,built/%,$(patsubst %.dot,%.png,$(SCREEN_SEQUENCE_DOTS))) |
UserStories.tex
View file @
600135c
... | ... | @@ -41,6 +41,8 @@ |
41 | 41 | \end{tabular} |
42 | 42 | \end{center} |
43 | 43 | \newpage |
44 | +\textbf{\LARGE{These User Stories supercede the the User Stories listed on the post it notes on the CSE Software Tools | |
45 | +Site. We were not able to remove those User Stories. Please use these as the User Stories. }} | |
44 | 46 | \tableofcontents |
45 | 47 | \section{ Account } |
46 | 48 | As a student, I want to be able to log in to the account I signed up with. |