110swag / docs

Download as
Browse Code ยป

Commit d8e1b7f698fb8320b112eb9a727d026d75cc9b37

Authored by Kevin Mach
2 parents 8f477cbd90 37d7dd0a52
Exists in master

fixed some word phrasings

Showing 1 changed file Side-by-side Diff

StoriesAndAcceptanceTests.tex View file @ d8e1b7f
... ... @@ -50,10 +50,10 @@
50 50 \item [Description:]{As a user, I want to be able to login, view my classes and decks while creating flashcards.}
51 51 \item [Steps:]
52 52 \begin{enumerate}
53   -\item User shall enter email TEST3@flashy.cards
54   -\item User shall enter password "test".
  53 +\item The user shall enter email TEST3@flashy.cards
  54 +\item The user shall enter password "test".
55 55 \end{enumerate}
56   -\item [Expected Result:]{User shall see the "Add Class" page.}
  56 +\item [Expected Result:]{The user shall see the "Add Class" page.}
57 57 \end{description}
58 58  
59 59 \subsection{User Password Change Acceptance Test}
60 60  
... ... @@ -64,8 +64,11 @@
64 64 \item User shall click "Change Password" on the "Settings" page.
65 65 \item User shall enter old password
66 66 \item User shall enter new password and confirm
  67 +\item The user shall click "Change Password"
  68 +\item The user shall enter old password
  69 +\item The user shall enter new password and confirm
67 70 \end{enumerate}
68   -\item [Expected Result:]{User's password is changed to new password.}
  71 +\item [Expected Result:]{The user's password is changed to new password.}
69 72 \end{description}
70 73  
71 74 \subsection{User Password Reset Acceptance Test}
72 75  
73 76  
... ... @@ -74,11 +77,11 @@
74 77 \item [Steps:]
75 78 \begin{enumerate}
76 79 \item
77   - {User shall click "Forgot Password?" from the login page.}
  80 + {The user shall click "Forgot Password?" from the login page.}
78 81 \item
79   - {User shall enter the email they used to sign up for an account.}
  82 + {The user shall enter the email they used to sign up for an account.}
80 83 \end{enumerate}
81   -\item[Expected Result:]{User's password will be reset and an email will be
  84 +\item[Expected Result:]{The user's password will be reset and an email will be
82 85 sent to the proper email allowing user to change their password.}
83 86 \end{description}
84 87  
85 88  
86 89  
... ... @@ -87,11 +90,17 @@
87 90 \item [Description:]{As a user, I want to be able to add myself to a class that I am in.}
88 91 \item [Steps:]
89 92 \begin{enumerate}
  93 +
90 94 \item {User shall click on the "Add Class" feature under the Class dropdown menu to visit the "Add Class" page.}
91 95 \item {User shall enter "CSE 3" in the input box.}
92 96 \item {User shall select the first choice for "CSE 3" and add class.}
  97 +
  98 +\item {The user shall visit the "Add Class" page.}
  99 +\item {The user shall enter "CSE 3" in the input box.}
  100 +\item {The user shall select the first choice for "CSE 3" and add class.}
  101 +
93 102 \end{enumerate}
94   -\item [Expected Result:]{User shall see the class "CSE 3" in their class list under
  103 +\item [Expected Result:]{The user shall see the class "CSE 3" in their class list under
95 104 the dropdown or sidebar.}
96 105 \end{description}
97 106  
98 107  
99 108  
... ... @@ -116,16 +125,22 @@
116 125 publish it for everyone to see.}
117 126 \item [Steps:]
118 127 \begin{enumerate}
119   -\item The user shall go to the live feed of the class he wants to create the flashcard
120   - for.
  128 +\item The user shall visit the feed for the ``CSE 3'' course
121 129 \item The user shall click on the '+' button at the lower right corner of the
122 130 screen. The user can press the "c" key on their keyboard to bring up the input box.
123 131 \item The user shall write the content of his flashcard in the input box that pops up
124 132 from the bottom of the screen and blanks the appropriate blanks.
125 133 \item The user shall press Enter or clicks on 'Submit' to submit the flashcard to
  134 +=======
  135 + screen.
  136 +\item The user shall write ``Hi I am a card'', and highlight ``card'' and press
  137 + Ctrl+B or click on 'Blank Selected Text' to mark it as a blank.
  138 +\item The user shall presse Enter or clicks on 'Submit' to submit the flashcard to
  139 +>>>>>>> 37d7dd0a524dc096e9f0e528c3b8aeec155e2704
126 140 the feed.
127 141 \end{enumerate}
128   -\item [Expected Result:]{The user shall see his flashcard added to the feed}
  142 +\item [Expected Result:]{The user shall see a flashcard with the text ``Hi I am
  143 + a card'' with the word ``card'' underlined added to the feed}
129 144 \end{description}
130 145  
131 146 \subsection{User Adds Flashcard to Deck For Class Acceptance Test}
... ... @@ -147,7 +162,7 @@
147 162 \begin{enumerate}
148 163 \item [Steps:] {The user shall click on the logout button at the top right corner.}
149 164 \end{enumerate}
150   -\item [Expected Result:] {User is logged out and is redirected to the login page.}
  165 +\item [Expected Result:] {The user is logged out and is redirected to the login page.}
151 166  
152 167 \end{description}
153 168  
154 169  
155 170  
... ... @@ -160,11 +175,11 @@
160 175 \item [Steps:]
161 176 \begin{enumerate}
162 177 \item
163   -{User shall visit the feed for the Test VIEW DECK course.}
  178 +{The user shall visit the feed for the Test VIEW DECK course.}
164 179 \item
165   -{User shall click on deck on top left.}
  180 +{The user shall click on deck on top left.}
166 181 \end{enumerate}
167   -\item [Expected Result:]{The test passes when the User sees
  182 +\item [Expected Result:]{The test passes when the user sees
168 183 the flashcard "This is a flashcard".}
169 184 \end{description}
170 185  
171 186  
... ... @@ -173,12 +188,12 @@
173 188 \item [Description:]{As a user, I want to be able to remove cards from my deck.}
174 189 \item [Steps:]
175 190 \begin{enumerate}
176   -\item The user shall select the section whose deck they want to remove the cards
177   - from.
178   -\item The user shall go to the deck view of that section.
179   -\item The user shall click hovers the mouse over the flashcard that he wants to
  191 +\item The user shall visit the feed for the ``CSE 3'' course.
  192 +\item The user shall click on the ``Deck'' button on the left side of the
  193 + navbar.
  194 +\item The user shall hover his mouse over the flashcard that he wants to
180 195 remove.
181   -\item The user shall click on the white-on-green '-' button that appears on the
  196 +\item The user shall click on the white-on-green ``-'' button that appears on the
182 197 flashcard.
183 198 \end{enumerate}
184 199 \item [Expected Result:]{The flashcard the user clicked on is removed from his deck}
185 200  
186 201  
187 202  
188 203  
189 204  
190 205  
191 206  
192 207  
... ... @@ -192,50 +207,41 @@
192 207 {As a user, I want to be able to study my deck.}
193 208 \item [Steps:]
194 209 \begin{enumerate}
195   -\item User shall visit the feed for the TEST9 course
196   -\item User shall create a card with the text ``Hello I am a card!'', with ``card'' selected as a blank.
197   -\item User shall click the Study button
  210 +\item The user shall visit the feed for the ``CSE 3'' course
  211 +\item The user shall create a card with the text ``Hello I am a card!'', with ``card'' selected as a blank.
  212 +\item The user shall click the Study button
198 213 \end{enumerate}
199   -\item [Expected Result:]{User shall see a card with the text``Hello I am a \underline{\hspace{1cm}}!''}
  214 +\item [Expected Result:]{The user shall see a card with the text``Hello I am a \underline{\hspace{1cm}}!''}
200 215 \end{description}
201 216  
202   -\section{Study}
203   -
204   -\subsection{User Study Filter Acceptance Test}
  217 +\subsection{User Study Negative Acceptance Test}
205 218 \begin{description}[style=multiline,leftmargin=5cm]
206   -\item [Description:]{As a user, I want to decide which flashcards I study.}
  219 +\item [Description:]{As a user, I want to respond with an answer when the app
  220 + quizzes me on a flashcard.}
207 221 \item [Steps:]
208 222 \begin{enumerate}
209   -\item The user shall click on the 'Study' button on the right side of the
210   - navbar.
211   -\item The user shall click on the button of the section whose cards he wants to
212   - study, or click on the 'All Classes' button to review cards from all
213   - sections.
214   -\item The user shall select the timeline of the cards he wants to study by
215   - clicking on the 'Begin' and 'End' input fields and selecting the appropriate
216   - dates from the date selection box that appears.
217   -\item The user shall click on 'Fetch' to fetch a flashcard to study.
  223 +\item The user shall visit the feed for the ``CSE 3'' course
  224 +\item The user shall click the Study button
  225 +\item The user shall type in anything other than ``card'' in the bottom field and hit enter.
  226 +\item The user shall click on on 'Check' to see if his answer was right or
  227 + wrong.
218 228 \end{enumerate}
219   -\item [Expected Result:]{If a flashcard with the given parameters is found, the
220   - user will be presented with this flashcard to study.}
  229 +\item [Expected Result:]{The user will be told that his guess was wrong.}
221 230 \end{description}
222 231  
223   -\subsection{User Study Acceptance Test}
  232 +\subsection{User Study Positive Acceptance Test}
224 233 \begin{description}[style=multiline,leftmargin=5cm]
225 234 \item [Description:]{As a user, I want to respond with an answer when the app
226 235 quizzes me on a flashcard.}
227 236 \item [Steps:]
228 237 \begin{enumerate}
229   -\item The user shall fetch a card to study.
230   -\item The user shall read the text of the flashcard presented on the top field.
231   -\item If the top field contains a blank, the user shall type in his guess for
232   - what goes in the blank in the bottom field. If there's no blank, the user
233   - shall type in nothin.
  238 +\item The user shall visit the feed for the ``CSE 3'' course
  239 +\item The user shall click the Study button
  240 +\item The user shall type in ``card'' in the bottom field and hit enter.
234 241 \item The user shall click on on 'Check' to see if his answer was right or
235 242 wrong.
236 243 \end{enumerate}
237   -\item [Expected Result:]{The user will be told whether his guess was right or
238   - wrong.}
  244 +\item [Expected Result:]{The user will be told that his guess was right.}
239 245 \end{description}
240 246 \end{document}