revision 1

BlankProjectTemplate/Doc_Revision1/DevelopmentPlan/DevelopmentPlan.tex

@@ -4,9 +4,9 @@
 \usepackage{booktabs}
 \usepackage{tabularx}
 \usepackage{hyperref}
+\usepackage{xcolor}
 
-
-\title{SE 3XA3: Development Plan\\Snake 2.o}
+\title{SE 3XA3: Development Plan\\\textcolor{red}{Snake 2.o}}
 
 \author{Team \# 30, VUA30
 		\\ Vaibhav Chadha , chadhav
@@ -32,6 +32,7 @@ Sept 27, 2018 & Vaibhav & Added the information from the meeting documents to th
 Sept 28, 2018 & Andy & Proof of concept, Git workflow, Final editing and formatting\\
 Sept 28, 2018 & Usman & Updated proof of concept\\
 Oct 12, 2018 & Andy & Made changes according to feedback on development plan and added section on POC demo\\
+\textcolor{red}{Dec 2, 2018} & Vaibhav Chadha & Revision one changes to improve the documents quality.\\
 \bottomrule
 \end{tabularx}
 \end{table}
@@ -109,7 +110,7 @@ The following procedures will be followed:
 \end{itemize}
 
 \section{Proof of Concept Demonstration Plan}
-The original project is built using Javascript, HTML and CSS in contrast to our development plan using python and the Pygame library. Since we are using an OOP language, we will be able to create classes for different components of the snake game such as the snake unit block, snake body, and snake bate. The hardest part of the implementation will be the movement of the snake according to the user's keyboard inputs, and second to that would be the process of expanding the snake once a food item is captured. Besides that, the interface may be difficult to implement in python but could be simple with the use of a python framework such as PyQT5.\\
+The original project is built using \textcolor{red}{JavaScript}, HTML and CSS in contrast to our development plan using python and the Pygame library. Since we are using an OOP language, we will be able to create classes for different components of the snake game such as the snake unit block, snake body, and snake bate. The hardest part of the implementation will be the movement of the snake according to the user's keyboard inputs, and second to that would be the process of expanding the snake once a food item is captured. Besides that, the interface may be difficult to implement in python but could be simple with the use of a python framework such as PyQT5.\\
 	Once our game application has been developed the next part would be to test the project and for that we will be using Pytest, since our backend language is python this will help us test all possible functions and aspects. The functions that will be difficult to test would be to see if the snake eats the food, does the food appear at random locations after eaten by the snake and if the snake tries to leave the borders, will the game end. Portability will have to be taken into consideration since the application is being built for windows. However, it can be compiled and run on any system as long as the necessary files and libraries are download.
 
 \subsection{POC Demo}
@@ -117,7 +118,7 @@ The team will be demonstrating the movement of a snake around the screen using u
 
 \section{Technology}
 
-Coding Language: Python, Kivy for GUI\\
+Coding Language: Python, \textcolor{red}{Kivy} for GUI\\
 IDE: IDLE scripting\\
 Testing: PyUnit testing\\
 Documentation: Doxygen\\
@@ -128,7 +129,7 @@ We will be using the \href{https://github.com/google/styleguide/blob/gh-pages/py
 for our coding style. It encompasses all the necessary naming conventions and standards required for the project development.
 
 \section{Project Schedule}
-Please see the following pages for the project schedule in the form of a gantt chart.
+Please see the following pages for the project schedule in the form of a \textcolor{red}{Gantt Chart}.
 
 \includepdf[page=-]{../../ProjectSchedule/Team_Gantt}
 

BlankProjectTemplate/Doc_Revision1/ProblemStatement/ProblemStatement.tex

@@ -2,8 +2,9 @@
 
 \usepackage{tabularx}
 \usepackage{booktabs}
+\usepackage{xcolor}
 
-\title{SE 3XA3: Problem Statement\\ \textbf{Snake Game}}
+\title{SE 3XA3: Problem Statement\\ \textbf{\textcolor{red}{Snake 2.o}}}
 
 \author{Team \#30, VUA30
 		\\ Usman Irfan - irfanm7
@@ -27,6 +28,7 @@
 2018-09-20 & Usman & Added the Importance of Problem section while formatting the LaTeX\\
 2018-09-21 & Andy Hameed & Formatted LaTeX file and added Context section, giving the final editing to the document\\
 2018-10-09 & Andy Hameed & Edited doc to reflect web app to desktop app decision change\\
+\textcolor{red}{2018-12-02} & Vaibhav Chadha & Revision one changes to make the document better.\\
 \bottomrule
 \end{tabularx}
 \end{table}
@@ -37,11 +39,11 @@
 
 \subsection*{The Problem}
 
-Almost everyone nowadays relies on a computer as a multipurpose tool for research, video streaming, gaming and many other tasks. With the emergence of fast computing, gaming has become a popular pastime activity and a source of entertainment for many. However, not everyone has a device powerful enough to support extensive game applications. A simple, memory effecient application of the Snake game allows it to be accessible for gamers without the need for extensive hardware or a high-performance computer. Our team, VUA30, will be creating a desktop application for the well-known Snake game with new enhancements and features. This competitive and addictive game can allow the user to play at their own pace and challenge their own high score. 
+Almost everyone nowadays relies on a computer as a multipurpose tool for research, video streaming, gaming and many other tasks. With the emergence of fast computing, gaming has become a popular pastime activity and a source of entertainment for many. However, not everyone has a device powerful enough to support extensive game applications. A simple, memory efficient application of the Snake game allows it to be accessible for gamers without the need for extensive hardware or a high-performance computer. Our team, VUA30, will be creating a desktop application for the well-known Snake game with new enhancements and features. This competitive and addictive game can allow the user to play at \textcolor{red}{different levels and challenge their own highscore} 
 
 \subsection*{Importance of the Problem}
 
-Buying a computing device with high storage and faster performance can be out of budget. Complicated software covers up all the storage and the user is bound to use these applications as opposed to downloading other software. The importance of the redevelopment of The Snake is to save computing devices' personal storage and allow the user to play a game 24/7 with strong performance, even offline. Creating a desktop version of the snake game can fit into the category of downloadable calssical games such as the solitaire suite. The recreation of this game will allow the user to enjoy the classical game anytime and anywhere as long as they have installed the application. Improving aspects such as graphics and custom speed will also make the game more interesting. We would like to add more features to the game to make it more customizable and help people enjoy the classical game in an exciting and new way.
+Buying a computing device with high storage and faster performance can be out of budget. Complicated software covers up all the storage and the user is bound to use these applications as opposed to downloading other software. The importance of the redevelopment of The Snake is to save computing \textcolor{red}{device's} personal storage and allow the user to play a game 24/7 with strong performance, even offline. Creating a desktop version of the snake game can fit into the category of downloadable calssical games such as the solitaire suite. The recreation of this game will allow the user to enjoy the classical game anytime and anywhere as long as they have installed the application. Improving aspects such as graphics and custom speed will also make the game more interesting. We would like to add more features to the game to make it more customizable and help people enjoy the classical game in an exciting and new way.
 
 
 \subsection*{Context}

BlankProjectTemplate/Doc_Revision1/SRS/SRS.tex

@@ -3,6 +3,7 @@
 \usepackage{booktabs}
 \usepackage{tabularx}
 \usepackage{hyperref}
+\usepackage{xcolor}
 \hypersetup{
     colorlinks,
     citecolor=black,
@@ -12,7 +13,7 @@
 }
 \usepackage[round]{natbib}
 
-\title{SE 3XA3: Software Requirements Specification\\Title of Project}
+\title{SE 3XA3: Software Requirements Specification\\\textcolor{red}{Snake 2.o}}
 
 \author{Team 30, VUA
 		\\ Andy Hameed and hameea1
@@ -38,7 +39,7 @@
 \toprule {\bf Date} & {\bf Version} & {\bf Notes}\\
 \midrule
 Oct 5, 2018 & 1.0 & Andy worked on Project Drivers and Project Issues. Usman worked on Functional requirements. Vaibhav worked on Non-Functional Requirements\\
-Date 2 & 1.1 & Notes\\
+\textcolor{red}{Dec 2, 2018} & 1.1 & Vaibhav is performing revision 1 in order to improve the quality of the document\\
 \bottomrule
 \end{tabularx}
 \end{table}
@@ -236,21 +237,21 @@ The snake should change its colour when it dies.\\
 
 \subsection{Look and Feel Requirements}
 
-\subsubsection{Appearance Requirements}
+\subsubsection{Appearance Requirements :\textcolor{red}{NFR1}}
 
-The final product shall be a desktop application which will contain a playground with a snake in it. It shall have different theme options and buttons to customize the speed of the snake. Also, it shall show the highest score made on the specific device.
+The final product shall be a desktop application which will contain a playground with a snake in it. It shall have different theme options and buttons to \textcolor{red}{select different modes to play with. In addition, there should be a help page for a new player in order to get familiar with the commands to play this game}. Also, it shall show the highest score made on the specific device.
 
-\subsubsection{Style Requirements}
+\subsubsection{Style Requirements:\textcolor{red}{NFR2}}
 
 The product should be given a modern style by adding a nice background to it with a user-friendly interface.
 
-\subsection{Usability and Humanity Requirements}
+\subsection{Usability and Humanity Requirements:\textcolor{red}{NFR3}}
 
 The application must be simple for a person aged 10 or above. It should be understandable by any person within the age group who is familiar to the technology. No feature should restrict the player to a non-knowledgeable outcome.
 
 \subsection{Performance Requirements}
 
-\subsubsection{Speed Requirements}
+\subsubsection{Speed Requirements:\textcolor{red}{NFR4}}
 
 \begin{description}
 	
@@ -261,61 +262,57 @@ The application must be simple for a person aged 10 or above. It should be under
 	
 \end{description}
 
-\subsubsection{Safety Critical requirements}
+\subsubsection{Safety Critical requirements :\textcolor{red}{NFR5}}
 
 The game shall not consume any private data from the user's device. 
 
-\subsubsection{Precision Requirements}
-\begin{description}
-	\item[$\bullet$] The speed of the snake should be consumed through integer values.
-	
-	\item[$\bullet$] The turn for snake should match with the users key and should be done as precisely as possible.
-\end{description}
+\subsubsection{Precision Requirements :\textcolor{red}{NFR6}}
+
+ The turn for snake should match with the users key and should be done as precisely as possible.
 
-\subsubsection{Reliability and Availability Requirements}
+\subsubsection{Reliability and Availability Requirements :\textcolor{red}{NFR7}}
 
 The game should be available 24 hours, 365 days per year to the user.
 
-\subsubsection{Capacity Requirements}
+\subsubsection{Capacity Requirements :\textcolor{red}{NFR8}}
 
 The game shall not overload the clients device's memory. 
 
 \subsection{Operational and Environmental Requirements}
 
-\subsubsection{Expected Physcial environment}
+\subsubsection{Expected Physcial environment :\textcolor{red}{NFR9}}
 
 The application is intended to be used anywhere, at any desktop device. It can be used in any climatic condition from harsh summers to chilly winter( given that the device is working as well).
 
-\subsubsection{Expected Technological environment}
+\subsubsection{Expected Technological environment :\textcolor{red}{NFR10}}
 
 This application should work on any desktop device as long as the device is working.
 
 \subsection{Maintainability and Support Requirements}
 
-\subsubsection{Maintainability}
+\subsubsection{Maintainability :\textcolor{red}{NFR11}}
 
-The application shall require minimum maintenance. Also, the application shall be revised every year.
+The application shall require minimum maintenance. Also, the application shall be revised every year. \textcolor{red}{Also, the code should be heavily commented in order to provide ease to the developer/maintainer.}
 
-\subsubsection{Portability}
+\subsubsection{Portability :\textcolor{red}{NFR12}}
 
 The application is expected to run on Windows, Mac OS and Linux environment.
 
-\subsection{Security Requirements}
+\subsection{Security Requirements :\textcolor{red}{NFR13}}
 
-This is an open-ended application. However, the application must not break the privacy policy by interfering with files stored on the desktop. Authors credits must be given when used by another party for any kind of development.
+This is an open-ended application. However, the application must not break the privacy policy by interfering with files stored on the desktop. 
 
-\subsection{Cultural Requirements}
+\subsection{Cultural Requirements :\textcolor{red}{NFR14}}
 
 The application will not use any kind of communicating data that will offend any religion, country or user in any way. The product will give a detailed explanation in case of use of any cultural or political symbol.
 
-\subsection{Legal Requirements}
+\subsection{Legal Requirements :\textcolor{red}{NFR15}}
 
 The application shall comply with all national and federal laws. In addition, the application must agree to the MIT Open License.
 
-\subsection{Health and Safety Requirements}
+\subsection{Health and Safety Requirements :\textcolor{red}{NFR16}}
 
-This section is not in the original Volere template, but health and safety are
-issues that should be considered for every engineering project.
+\textcolor{red}{This software should not affect the health of the user by any means. Contrast ratio for the colors should be used in order to achieve the most safe colors for the game.}
 
 \section{Project Issues}
 

BlankProjectTemplate/Doc_Revision1/TestPlan/TestPlan.tex

@@ -4,7 +4,10 @@
 \usepackage{tabularx}
 \usepackage{hyperref}
 \usepackage{amsmath}
+\usepackage{xcolor}
 \usepackage{url}
+
+
 \hypersetup{
     colorlinks,
     citecolor=black,
@@ -41,7 +44,7 @@
 \midrule
 10/25/2018 & 1.0 & Usman added section 3.1, Vaibhav added section 3.2, Andy added section 4. \\
 10/26/2018 & 1.0 & Andy added section 1 and 7, Vaibhav added section 2 and 5, Usman added section 6.\\
-Date 2 & 1.1 & Notes\\
+\textcolor{red}{12/2/2018} & 1.1 & Vaibhav is doing the revision 1 in order to improve the documents quality\\
 \bottomrule
 \end{tabularx}
 \end{table}
@@ -401,11 +404,11 @@ How test will be performed: The developer will test this requirement by intentio
 	
 	Initial State: The snake Game will be running on the device.
 	
-	Input/Condition: Various speed inputs for the snake.
+	Input/Condition: \textcolor{red}{Different modes will be played}.
 	
-	Output/Result: Different snake speeds according to what the user has decided
+	Output/Result: \textcolor{red}{Snake's speed variation will be observed between different modes.}
 	
-	How the test will be performed: The game will be played with inputting different speeds. Then, the speed difference will be observed as the game progressed through and taken care that the game goes at the constant speed at each level.
+	How the test will be performed: \textcolor{red}{The game will be played with selecting 1 of the 3 different levels. Then, the speed difference will be observed as the game progresses through. Also, it will be taken care that the game goes at constant speed within a specific level.}
 	
 	\item{\textbf{TID21}\\}