Development Plan Rev0

Doc/DevelopmentPlan/DevelopmentPlan.tex

@@ -21,8 +21,11 @@
 
 \maketitle
 
+\tableofcontents
+\newpage
+
 Ultimate Tic Tac Toe is a variation on the classic game of Tic Tac Toe. It is 
-simply multiple games of Tic Tac Toe running simultaneously to make a clasic 
+simply multiple games of Tic Tac Toe running simultaneously to make a classic 
 game that often ends in a draw have an exciting ending.
 
 \section{Team Meeting Plan}
@@ -36,7 +39,7 @@ last meeting and what we plan to accomplish before the next meeting.
 \section{Team Communication Plan}
 All team communication about setting group
 meetings and project related communication will occur on the FaceBook messenger
-group chat. Skype will be used to conduct ''virtual'' face to face eetings
+group chat. Skype will be used to conduct ''virtual'' face to face meetings
 outside of lab. Git issues will be used for setting milestones, delegating tasks
 and reporting bugs in the program.
 
@@ -48,47 +51,50 @@ and saving a PDF copy to the git repository. Other Member roles are distributed
 as follows:
 \begin{itemize}
   \item Kunal: Developer, LaTex Technology Expert, HTML, CSS Expert 
-  \item Pareek: Developer,Git Technology Expert, JavaScript Expert 
+  \item Pareek: Developer,Git Technology Expert, Gantt Expert, JavaScript Expert 
 
 \end{itemize}
 
 \section{Git Workflow Plan}
-Our team will be using a Master only git workflow. This means all code will be pushed 
-to the master branch. Every milestone commit will be tagged with its predefined identifier.
-
-\section{Proof of Concept Demonstration Plan} The proof of concept demonstration
-will involve the fundamental game dynamics  fully working. This will include the
-logic to determine if a move is valid, if a  player has taken control of one
-inner board and if a player has won the entire  game. It will also have user
-inputs from the same local machine for up to 5  moves each. One possible
-difficulty is the testing with the Karma Unit Testing  tool as it is something
-that we have never used before. We hope to implement  this game using a local
-server so people can play the game on their own devices.  This will be an
-additional feature to add if the time frame permits it because  of the
-complexity of it. We do not foresee any difficulties in installing  external
-libraries. The aim is to have this application running on all forms of  devices;
-mobile, tablet and computer. With modifications to the CSS, this should  be
-achievable.
+Our team will be using a Master only git workflow.
+This means all code will be pushed to the master branch. Every milestone commit
+will be tagged with its predefined identifier. If code that is currently work in
+progress is pushed to the repository, it's commit message must indicate that with the
+string "WIP". If there is code that is not working, it must have a git issue
+linked to the commit.
+
+\section{Proof of Concept Demonstration Plan}
+The proof of concept demonstration will involve the fundamental game dynamics
+fully working. This will include the logic to determine if a move is valid, if a
+player has taken control of one inner board and if a player has won the entire
+game. It will also have user inputs from the same local machine for up to 5
+moves each. One possible difficulty is the testing with the Karma Unit Testing
+tool as it is something that we have never used before. We hope to implement
+this game using a local server so people can play the game on their own devices.
+This will be an additional feature to add if the time frame permits it because
+of the complexity of it. We do not foresee any difficulties in installing
+external libraries. The aim is to have this application running on all forms of
+devices; mobile, tablet and computer. With modifications to the CSS, this should
+be achievable.
 
 \section{Technology}
 Technologies that will be used include:
 
 \begin{itemize}
 
-  \item Git
-  \item LaTex
-  \item Javascript
-  \item HTML
-  \item CSS
-  \item JsDoc documentation generation
-  \item Karma Javascript Unit Testing 
+  \item Git - Project version control
+  \item LaTex - Document preparation system
+  \item Javascript - Programing language for interactive effects within web browsers
+  \item HTML - Standard language for World Wide Web sites.
+  \item CSS - HTML Styling Language 
+  \item JsDoc - Documentation generation system
+  \item Karma - Javascript Unit Testing system 
 
 \end{itemize}
 
 \section{Coding Style}
-The project shall be coded using the
-\href{https://google.github.io/styleguide/javascriptguide.xml}{\textcolor{blue}{Google Javascript
-style guidelines}}
+The project shall be coded using the \href{https://google.github.io/styleguide/javascriptguide.xml}
+{\textcolor{blue}{Google Javascript style guidelines}}
 
 \section{Project Schedule}
 
@@ -107,9 +113,9 @@ Pointer to \href{run:Gantt Chart.gan}{\textcolor{blue}{Gantt Chart}}.
 September 28 & Pareek Ravi & Initial Setup\\
 September 28 & Pareek Ravi and Kunal Shah & Started on Development Plan\\
 September 29 & Kunal Shah & Team Meeting Plan, Team Communication Plan and Team Member Roles\\
-September 29 & Pareek Ravi & Proof of Concept Demonstration Plan , Gannt Chart\\
+September 29 & Pareek Ravi & Proof of Concept Demonstration Plan , Gantt Chart\\
 September 30 & Kunal Shah & Technology , Git Workflow Plan \\
-... & ... & ...\\
+September 30 & Kunal Shah & Coding Style and updated Technology\\
 \bottomrule
 \end{tabularx}
 \end{table}