110swag / docs

Commit 44fca697dd9af0bec92cb8dca4823408ce65fc2d

Authored by Rohan Rangray 2015-06-05 00:17:58 -0700

Exists in master

Merge branch 'master' of git.ucsd.edu:110swag/docs

mergin

Showing 2 changed files Side-by-side Diff

DesignUseCases.tex
TestCases.tex

...	...	@@ -1107,17 +1107,20 @@
1107	1107	\\
1108	1108	\item[Priority Level]{``Must''}
1109	1109
1110		-\item[Status]{Not implemented.}
	1110	+\item[Status]{Implemented.}
1111	1111
1112	1112	\item[Pre-conditions]
1113	1113
1114	1114	\begin{itemize}
1115	1115	\itemsep1pt\parskip0pt\parsep0pt
1116	1116	\item
1117		- {The User has the flashcard he wishes to blank out words from in his
1118		- deck.}
	1117	+ {The User has an account and is logged in.}
1119	1118	\item
1120		- {The User shall (be on the class page and) view deck}
	1119	+ {The User shall be on the Live Feed for the class.}
	1120	+\item
	1121	+ {The User has clicked the 'c' hotkey or the 'plus' button to start making a card.}
	1122	+\item
	1123	+ {The User shall type in information relevant to their class.}
1121	1124	\end{itemize}
1122	1125
1123	1126	{Post-conditions: }
1124	1127
1125	1128
1126	1129
1127	1130
1128	1131
...	...	@@ -1131,35 +1134,23 @@
1131	1134	they are when it presents the flashcard to the User for reviewing.}
1132	1135	\end{itemize}
1133	1136
1134		-\item[Trigger]{The User clicks on a flashcard.}
	1137	+\item[Trigger]{The User wants to make a flashcard and be quizzed on parts of the flashcard while they study.}
1135	1138
1136	1139	\item[Workflow]
1137	1140
1138	1141	\begin{enumerate}
1139	1142	\itemsep1pt\parskip0pt\parsep0pt
1140	1143	\item
1141		- {The Client shall a show deck to user}
	1144	+ {The User shall highlight the words that he wishes to blank out.}
1142	1145	\item
1143		- {The User shall click on the flashcard in his deck that he wants to
1144		- blank out words from}
	1146	+ {The User shall click the 'Contribute' button.}
1145	1147	\item
1146		- {The client shall bring user to edit flashcard page/popup}
	1148	+ {The backend shall mark those words by updating the field mask for
	1149	+ that userflashcard object in views.py in function create. }
1147	1150	\item
1148		- {The User shall click on the words that he wishes to blank out}
	1151	+ {The backend shall save those in models.py.}
1149	1152	\item
1150		- {The client shall specify a character range as blank}
1151		-\item
1152		- {The server shall mark those words by updating the Flashcard Mask for
1153		- that flashcard. }
1154		-\item
1155		- {The User shall click on `Save' or the equivalent button to save the
1156		- changes}
1157		-\item
1158		- {The server will save the blanked out words as keywords to the
1159		- Flashcard Mask to review}
1160		-\item
1161		- {The client shall cover the keywords with whitespace to hide them from
1162		- the User}
	1153	+ {The frontend shall change the color of the text that was blanked out in flashcard.html.}
1163	1154	\end{enumerate}
1164	1155
1165	1156	{Alternative Workflows:}
1166	1157
1167	1158
1168	1159
1169	1160
...	...	@@ -1167,20 +1158,17 @@
1167	1158	\begin{enumerate}
1168	1159	\itemsep1pt\parskip0pt\parsep0pt
1169	1160	\item
1170		- {The User shall (be on the class page and) click ``Make New
1171		- Flashcard''}
	1161	+ {Precondition: The User has clicked the edit flashcard button instead of creating a new card.}
1172	1162	\item
1173		- {The client shall present user with a new flashcard to fill in}
	1163	+ {The User shall highlight selection text and click either ctrl-b or 'Blank Selected Text'.}
1174	1164	\item
1175		- {The User shall fill in the information}
	1165	+ {The backend shall mark those words by updating the field mask for
	1166	+ that userflashcard object in views.py in function create. }
1176	1167	\item
1177		- {The client shall ask if the user wants to specify blanks}
	1168	+ {The backend shall save those in models.py.}
1178	1169	\item
1179		- {The System will save the blanked out words as keywords to the
1180		- Flashcard Mask to review}
1181		-\item
1182		- {The client shall cover the keywords with whitespace to hide them from
1183		- the User}
	1170	+ {The frontend shall change the color of the text that was blanked out in flashcard.html.}
	1171	+
1184	1172	\end{enumerate}
1185	1173	\end{description}
1186	1174	{}

...	...	@@ -1575,10 +1575,10 @@
1575	1575	\item[Description:]{This test case outlines the presentation layering step
1576	1576	process of a user viewing all the cards in their deck.}
1577	1577
1578		-\item[Desired Outcome:]{The User views all the cards in their deck.}
	1578	+\item[Desired Outcome:]{The User shall be able to view all the cards in their deck.}
1579	1579	\\
1580	1580
1581		-\item[User Goals:]{To see all pulled cards for easier editing purpose.}
	1581	+\item[User Goals:]{To see all pulled cards for easier editing purposes.}
1582	1582
1583	1583	\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login,
1584	1584	[A3] Add a Class, [F1] Push Flashcard, [F3] Pull Flashcard}
...	...	@@ -1597,7 +1597,7 @@
1597	1597	\item
1598	1598	{UserX and UserY are registered for class TEST 101.}
1599	1599	\item
1600		- {UserX and UserY at the feed view for TEST 101.}
	1600	+ {UserX and UserY are at the feed view for TEST 101.}
1601	1601	\end{itemize}
1602	1602
1603	1603	\item[Postconditions:]
...	...	@@ -1638,8 +1638,8 @@
1638	1638	{UserY shall go to their Deck View.}
1639	1639	\end{enumerate}
1640	1640
1641		-\item[Expected Results]{For TEST1@flashy.cards the cards are listed in the
1642		- order ``Card B'', ``Card A'' and for testuser@flashy.cards they are in the
	1641	+\item[Expected Results]{For UserX the cards are listed in the
	1642	+ order ``Card B'', ``Card A'' and for UserY they are in the
1643	1643	deck view as ``Card A'', ``Card B''.}
1644	1644
1645	1645	\end{description}
1646	1646
1647	1647
1648	1648
1649	1649
1650	1650
...	...	@@ -1670,28 +1670,26 @@
1670	1670	\begin{itemize}
1671	1671	\itemsep1pt\parskip0pt\parsep0pt
1672	1672	\item
1673		- {The User has registered with the email testuser@flashy.cards.}
	1673	+ {The User is logged in as UserX.}
1674	1674	\item
1675		- {The User has verified their email address.}
	1675	+ {The User has enrolled in the class TEST 101.}
1676	1676	\item
1677		- {The User is logged in with the above email.}
	1677	+ {The User has enrolled in the class TEST 102.}
1678	1678	\item
1679		- {The user has enrolled in the class TEST Study.}
	1679	+ {The User has enrolled in the class TEST 103.}
1680	1680	\item
1681		- {The User has flashcards in their deck.}
	1681	+ {The User has two flashcards in their TEST 101 deck, ``Hello, I am
	1682	+a \textbf{flashcard} and I was added first'', ``I am clearly
	1683	+the superior card''.}
	1684	+\item
	1685	+ {The User has two flashcards in their TEST 102 deck, ``I hope you don't \textbf{see me}'' and ``\textbf{STUDY TIME}, dun dun dun''.}
	1686	+\item
	1687	+ {The User has no flashcards in their TEST 103 deck.}
1682	1688	\end{itemize}
1683	1689
1684	1690	\item[Postconditions:]
1685	1691	\begin{itemize}
1686	1692	\itemsep1pt\parskip0pt\parsep0pt
1687		-\item
1688		- {The User shall see a single card with blanks.}
1689		-\item
1690		- {The User shall be presented with a text box to fill in for the blank space.}
1691		-\item
1692		- {The User's response shall be stored on the server.}
1693		-\item
1694		- {The User can choose whether their response is correct or not.}
1695	1693	\end{itemize}
1696	1694
1697	1695	\item[Trigger:]{UserX wishes to study flashcards compiled for a specific class.}
1698	1696
1699	1697
1700	1698
1701	1699
1702	1700
1703	1701
1704	1702
1705	1703
...	...	@@ -1700,24 +1698,46 @@
1700	1698	\begin{enumerate}
1701	1699	\itemsep1pt\parskip0pt\parsep0pt
1702	1700	\item
1703		- {UserX shall click on the study button on top right corner.}
	1701	+ {UserX shall click on ``Study'' (magnifying glass in a square) in
	1702	+the top navigation bar.}
1704	1703	\item
1705		- {The System shall present a modal that contains the flashcard and blanks to fill in.}
	1704	+ {UserX shall choose to study for TEST 101.}
1706	1705	\item
1707		- {UserX shall fill in ``test'' in the blank.}
	1706	+ {UserX shall click ``Fetch!''}
1708	1707	\item
1709		- {UserX shall click ``CHECK'' button to submit the response.}
	1708	+ {The System shall present UserX with card, ``Hello, I am a \rule{1.5cm}{0.15mm} and I was added first''.}
1710	1709	\item
1711		- {The System shall display a new modal with the answer of the flashcard.}
	1710	+ {UserX shall enter ``Flashcard'' in the Answer input box.}
1712	1711	\item
1713		- {UserX shall click ``Yes'' button. (Either YES or NO leads to the same behavior for the User)}
	1712	+ {UserX shall click ``Check''.}
1714	1713	\item
1715		- {The Server saves the response and updates statistics about the flashcard.}
	1714	+ {The System shall present UserX with the actual card and the card with UserX's response with ``flashcard'' and ``Flashcard'' bolded.}
1716	1715	\item
1717		- {Loop back to 2.}
	1716	+ {UserX shall determine if they have properly filled in the blank. Since a
	1717	+little uppercase/lowercase difference is not a big deal, UserX shall click
	1718	+``Yes'' where asked if their response was correct.}
	1719	+\item
	1720	+ {The System shall present UserX with card ``Clearly I am the superior card''
	1721	+and notify UserX that the card has no blanks.}
	1722	+\item
	1723	+ {UserX shall click ``Next'' after reviewing the card.}
1718	1724	\end{enumerate}
1719	1725
1720		-\item[Expected Results]{The workflow should be able to loop continuously.}
	1726	+\item[Expected Result:] {The System shall once again present UserX with
	1727	+``Hello, I am a \rule{1.5cm}{0.15mm} and I was added first''.}
	1728	+
	1729	+\item[Workflow:]
	1730	+\begin{enumerate}
	1731	+\setcounter{enumi}{2}
	1732	+\itemsep1pt\parskip0pt\parsep0pt
	1733	+\item
	1734	+ {UserX shall select ``TEST 103'' to study.}
	1735	+\item
	1736	+ {UserX shall click ``Fetch''.}
	1737	+\end{enumerate}
	1738	+
	1739	+\item[Expected Result:] {The System shall display a toast, ``Can't study;
	1740	+there aren't any cards in your deck for the selection actions.''}
1721	1741	\end{description}
1722	1742	\newpage
1723	1743