110swag / docs

Download as
Browse Code ยป

Commit 382c67f685c8bbf6d9447cda4a9054d633db04d6

Authored by Kevin Mach
1 parent d8e1b7f698
Exists in master

got rid of merge conflicts

Showing 1 changed file with 6 additions and 9 deletions Inline Diff

StoriesAndAcceptanceTests.tex View file @ 382c67f
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge User Story Acceptance Test Plan} 5 5 \title{\huge User Story Acceptance Test Plan}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Phuong Tran & Quality Assurance Lead \\ 37 37 Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\tableofcontents 44 44 \tableofcontents
45 45
\newpage 46 46 \newpage
\section{Account} 47 47 \section{Account}
\subsection{User Login Acceptance Test} 48 48 \subsection{User Login Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 49 49 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to be able to login, view my classes and decks while creating flashcards.} 50 50 \item [Description:]{As a user, I want to be able to login, view my classes and decks while creating flashcards.}
\item [Steps:] 51 51 \item [Steps:]
\begin{enumerate} 52 52 \begin{enumerate}
\item The user shall enter email TEST3@flashy.cards 53 53 \item The user shall enter email TEST3@flashy.cards
\item The user shall enter password "test". 54 54 \item The user shall enter password "test".
\end{enumerate} 55 55 \end{enumerate}
\item [Expected Result:]{The user shall see the "Add Class" page.} 56 56 \item [Expected Result:]{The user shall see the "Add Class" page.}
\end{description} 57 57 \end{description}
58 58
\subsection{User Password Change Acceptance Test} 59 59 \subsection{User Password Change Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 60 60 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to be able to change my login password.} 61 61 \item [Description:]{As a user, I want to be able to change my login password.}
\item [Steps:] 62 62 \item [Steps:]
\begin{enumerate} 63 63 \begin{enumerate}
\item User shall click "Change Password" on the "Settings" page. 64 64 \item User shall click "Change Password" on the "Settings" page.
\item User shall enter old password 65 65 \item User shall enter old password
\item User shall enter new password and confirm 66 66 \item User shall enter new password and confirm
\item The user shall click "Change Password" 67 67 \item The user shall click "Change Password"
\item The user shall enter old password 68 68 \item The user shall enter old password
\item The user shall enter new password and confirm 69 69 \item The user shall enter new password and confirm
\end{enumerate} 70 70 \end{enumerate}
\item [Expected Result:]{The user's password is changed to new password.} 71 71 \item [Expected Result:]{The user's password is changed to new password.}
\end{description} 72 72 \end{description}
73 73
\subsection{User Password Reset Acceptance Test} 74 74 \subsection{User Password Reset Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 75 75 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to be able to reset my password if I forget it.} 76 76 \item [Description:]{As a user, I want to be able to reset my password if I forget it.}
\item [Steps:] 77 77 \item [Steps:]
\begin{enumerate} 78 78 \begin{enumerate}
\item 79 79 \item
{The user shall click "Forgot Password?" from the login page.} 80 80 {The user shall click "Forgot Password?" from the login page.}
\item 81 81 \item
{The user shall enter the email they used to sign up for an account.} 82 82 {The user shall enter the email they used to sign up for an account.}
\end{enumerate} 83 83 \end{enumerate}
\item[Expected Result:]{The user's password will be reset and an email will be 84 84 \item[Expected Result:]{The user's password will be reset and an email will be
sent to the proper email allowing user to change their password.} 85 85 sent to the proper email allowing user to change their password.}
\end{description} 86 86 \end{description}
87 87
\subsection{User Adds Themselves to Class Acceptance Test} 88 88 \subsection{User Adds Themselves to Class Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 89 89 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to be able to add myself to a class that I am in.} 90 90 \item [Description:]{As a user, I want to be able to add myself to a class that I am in.}
\item [Steps:] 91 91 \item [Steps:]
\begin{enumerate} 92 92 \begin{enumerate}
93 93
\item {User shall click on the "Add Class" feature under the Class dropdown menu to visit the "Add Class" page.} 94 94 \item {User shall click on the "Add Class" feature under the Class dropdown menu to visit the "Add Class" page.}
\item {User shall enter "CSE 3" in the input box.} 95 95 \item {User shall enter "CSE 3" in the input box.}
\item {User shall select the first choice for "CSE 3" and add class.} 96 96 \item {User shall select the first choice for "CSE 3" and add class.}
97 97
\item {The user shall visit the "Add Class" page.} 98 98 \item {The user shall visit the "Add Class" page.}
\item {The user shall enter "CSE 3" in the input box.} 99 99 \item {The user shall enter "CSE 3" in the input box.}
\item {The user shall select the first choice for "CSE 3" and add class.} 100 100 \item {The user shall select the first choice for "CSE 3" and add class.}
101 101
\end{enumerate} 102 102 \end{enumerate}
\item [Expected Result:]{The user shall see the class "CSE 3" in their class list under 103 103 \item [Expected Result:]{The user shall see the class "CSE 3" in their class list under
the dropdown or sidebar.} 104 104 the dropdown or sidebar.}
\end{description} 105 105 \end{description}
106 106
\subsection{Deck for Each Section Acceptance Test} 107 107 \subsection{Deck for Each Section Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 108 108 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to see the cards in my deck for each deck 109 109 \item [Description:]{As a user, I want to see the cards in my deck for each deck
associated with a section I'm enrolled in.} 110 110 associated with a section I'm enrolled in.}
\item [Steps:] 111 111 \item [Steps:]
\begin{enumerate} 112 112 \begin{enumerate}
\item The user shall click on the section of the deck from the drop down menu at the 113 113 \item The user shall click on the section of the deck from the drop down menu at the
right end of the top navbar. 114 114 right end of the top navbar.
\item The user shall click on the Deck button on the left side of the navbar. 115 115 \item The user shall click on the Deck button on the left side of the navbar.
\end{enumerate} 116 116 \end{enumerate}
\item [Expected Result:]{The user shall now see the cards in the deck he chose.} 117 117 \item [Expected Result:]{The user shall now see the cards in the deck he chose.}
\end{description} 118 118 \end{description}
119 119
\newpage 120 120 \newpage
\section{Flashcards} 121 121 \section{Flashcards}
\subsection{User Makes a Flashcard Acceptance Test} 122 122 \subsection{User Makes a Flashcard Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 123 123 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to be able to create a flashcard and 124 124 \item [Description:]{As a user, I want to be able to create a flashcard and
publish it for everyone to see.} 125 125 publish it for everyone to see.}
\item [Steps:] 126 126 \item [Steps:]
\begin{enumerate} 127 127 \begin{enumerate}
\item The user shall visit the feed for the ``CSE 3'' course 128 128 \item The user shall visit the feed for the ``CSE 3'' course
\item The user shall click on the '+' button at the lower right corner of the 129 129 \item The user shall click on the '+' button at the lower right corner of the
screen. The user can press the "c" key on their keyboard to bring up the input box. 130 130 screen. The user can press the "c" key on their keyboard to bring up the input box.
\item The user shall write the content of his flashcard in the input box that pops up 131 131 \item The user shall write the content of his flashcard in the input box that pops up
from the bottom of the screen and blanks the appropriate blanks. 132 132 from the bottom of the screen and blanks the appropriate blanks.
\item The user shall press Enter or clicks on 'Submit' to submit the flashcard to 133 133 \item The user shall press Enter or clicks on 'Submit' to submit the flashcard to screen.
======= 134
screen. 135
\item The user shall write ``Hi I am a card'', and highlight ``card'' and press 136 134 \item The user shall write ``Hi I am a card'', and highlight ``card'' and press
Ctrl+B or click on 'Blank Selected Text' to mark it as a blank. 137 135 Ctrl+B or click on 'Blank Selected Text' to mark it as a blank.
\item The user shall presse Enter or clicks on 'Submit' to submit the flashcard to 138 136 \item The user shall presse Enter or clicks on 'Submit' to submit the flashcard to the feed.
>>>>>>> 37d7dd0a524dc096e9f0e528c3b8aeec155e2704 139
the feed. 140
\end{enumerate} 141 137 \end{enumerate}
\item [Expected Result:]{The user shall see a flashcard with the text ``Hi I am 142 138 \item [Expected Result:]{The user shall see a flashcard with the text ``Hi I am
a card'' with the word ``card'' underlined added to the feed} 143 139 a card'' with the word ``card'' underlined added to the feed}
\end{description} 144 140 \end{description}
145 141
\subsection{User Adds Flashcard to Deck For Class Acceptance Test} 146 142 \subsection{User Adds Flashcard to Deck For Class Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 147 143 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to add a card from the feed to my deck.} 148 144 \item [Description:]{As a user, I want to add a card from the feed to my deck.}
\item [Steps:] 149 145 \item [Steps:]
\begin{enumerate} 150 146 \begin{enumerate}
\item The user shall go to the live feed of the class he wants to pull the flashcard 151 147 \item The user shall go to the live feed of the class he wants to pull the flashcard from.
from. 152
\item The user shall click on the flashcard that he wants to add to his deck. 153 148 \item The user shall click on the flashcard that he wants to add to his deck.
\end{enumerate} 154 149 \end{enumerate}
\item [Expected Result:]{The flashcard the user clicked on is added to his deck} 155 150 \item [Expected Result:]{The flashcard the user clicked on is added to his deck}
\end{description} 156 151 \end{description}
157 152
158 153
\subsection{User Logs Out Acceptance Test} 159 154 \subsection{User Logs Out Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 160 155 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:] {As a user, I want to log out of my account.} 161 156 \item [Description:] {As a user, I want to log out of my account.}
157 \item [Steps:]
\begin{enumerate} 162 158 \begin{enumerate}
\item [Steps:] {The user shall click on the logout button at the top right corner.} 163 159 \item [Description:]
160 {The user shall click on the logout button at the top right corner.}
\end{enumerate} 164 161 \end{enumerate}
\item [Expected Result:] {The user is logged out and is redirected to the login page.} 165 162 \item [Expected Result:] {The user is logged out and is redirected to the login page.}
166 163
\end{description} 167 164 \end{description}
168 165
\newpage 169 166 \newpage
\section{Decks} 170 167 \section{Decks}
\subsection{View Cards in Deck Acceptance Test} 171 168 \subsection{View Cards in Deck Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 172 169 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:] 173 170 \item [Description:]
{As a user, I want to be able to view the cards that I have included in my deck.} 174 171 {As a user, I want to be able to view the cards that I have included in my deck.}
\item [Steps:] 175 172 \item [Steps:]
\begin{enumerate} 176 173 \begin{enumerate}
\item 177 174 \item
{The user shall visit the feed for the Test VIEW DECK course.} 178 175 {The user shall visit the feed for the Test VIEW DECK course.}
\item 179 176 \item
{The user shall click on deck on top left.} 180 177 {The user shall click on deck on top left.}
\end{enumerate} 181 178 \end{enumerate}
\item [Expected Result:]{The test passes when the user sees 182 179 \item [Expected Result:]{The test passes when the user sees
the flashcard "This is a flashcard".} 183 180 the flashcard "This is a flashcard".}
\end{description} 184 181 \end{description}
185 182
\subsection{Remove Card from Deck Acceptance Test} 186 183 \subsection{Remove Card from Deck Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 187 184 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to be able to remove cards from my deck.} 188 185 \item [Description:]{As a user, I want to be able to remove cards from my deck.}
\item [Steps:] 189 186 \item [Steps:]
\begin{enumerate} 190 187 \begin{enumerate}
\item The user shall visit the feed for the ``CSE 3'' course. 191 188 \item The user shall visit the feed for the ``CSE 3'' course.
\item The user shall click on the ``Deck'' button on the left side of the 192 189 \item The user shall click on the ``Deck'' button on the left side of the
navbar. 193 190 navbar.
\item The user shall hover his mouse over the flashcard that he wants to 194 191 \item The user shall hover his mouse over the flashcard that he wants to
remove. 195 192 remove.
\item The user shall click on the white-on-green ``-'' button that appears on the 196 193 \item The user shall click on the white-on-green ``-'' button that appears on the
flashcard. 197 194 flashcard.
\end{enumerate} 198 195 \end{enumerate}
\item [Expected Result:]{The flashcard the user clicked on is removed from his deck} 199 196 \item [Expected Result:]{The flashcard the user clicked on is removed from his deck}
\end{description} 200 197 \end{description}
201 198
\newpage 202 199 \newpage
\section{Study} 203 200 \section{Study}
\subsection{Study Deck Acceptance Test} 204 201 \subsection{Study Deck Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 205 202 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:] 206 203 \item [Description:]
{As a user, I want to be able to study my deck.} 207 204 {As a user, I want to be able to study my deck.}
\item [Steps:] 208 205 \item [Steps:]
\begin{enumerate} 209 206 \begin{enumerate}
\item The user shall visit the feed for the ``CSE 3'' course 210 207 \item The user shall visit the feed for the ``CSE 3'' course
\item The user shall create a card with the text ``Hello I am a card!'', with ``card'' selected as a blank. 211 208 \item The user shall create a card with the text ``Hello I am a card!'', with ``card'' selected as a blank.
\item The user shall click the Study button 212 209 \item The user shall click the Study button
\end{enumerate} 213 210 \end{enumerate}
\item [Expected Result:]{The user shall see a card with the text``Hello I am a \underline{\hspace{1cm}}!''} 214 211 \item [Expected Result:]{The user shall see a card with the text``Hello I am a \underline{\hspace{1cm}}!''}
\end{description} 215 212 \end{description}
216 213
\subsection{User Study Negative Acceptance Test} 217 214 \subsection{User Study Negative Acceptance Test}
\begin{description}[style=multiline,leftmargin=5cm] 218 215 \begin{description}[style=multiline,leftmargin=5cm]
\item [Description:]{As a user, I want to respond with an answer when the app 219 216 \item [Description:]{As a user, I want to respond with an answer when the app
quizzes me on a flashcard.} 220 217 quizzes me on a flashcard.}
\item [Steps:] 221 218 \item [Steps:]
\begin{enumerate} 222 219 \begin{enumerate}
\item The user shall visit the feed for the ``CSE 3'' course 223 220 \item The user shall visit the feed for the ``CSE 3'' course
\item The user shall click the Study button 224 221 \item The user shall click the Study button
\item The user shall type in anything other than ``card'' in the bottom field and hit enter. 225 222 \item The user shall type in anything other than ``card'' in the bottom field and hit enter.
\item The user shall click on on 'Check' to see if his answer was right or 226 223 \item The user shall click on on 'Check' to see if his answer was right or
wrong. 227 224 wrong.
\end{enumerate} 228 225 \end{enumerate}
\item [Expected Result:]{The user will be told that his guess was wrong.} 229 226 \item [Expected Result:]{The user will be told that his guess was wrong.}
\end{description} 230 227 \end{description}