Skip to content
Snippets Groups Projects
Commit 6305d9ef authored by Susan Yuen's avatar Susan Yuen
Browse files

Updated the Development Plan

parent 89cc9840
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Doc/DevelopmentPlan/DevelopmentPlan.pdf
+ 0
− 0
View file @ 6305d9ef
No preview for this file type
Doc/DevelopmentPlan/DevelopmentPlan.synctex.gz 0 → 100644
+ 0
− 0
View file @ 6305d9ef
File added
Doc/DevelopmentPlan/DevelopmentPlan.tex
+ 75
− 91
View file @ 6305d9ef
\documentclass{article}
\usepackage[dvipsnames]{xcolor}
\usepackage{booktabs}
\usepackage {graphicx}
\usepackage{graphicx}
\usepackage{tabularx}
\newcommand{\bigcell}[2]{\begin{tabular}{@{}#1@{}}#2\end{tabular}}
\newpage
\title{ \vspace{40mm}
\textbf {
\Huge {\color[rgb]{0.9,0,0}Blaze} Brigade \\
\large - Development Plan -}}
\date{September 28, 2016}
\date{\today}
\author{SFWR ENG 3XA3 - Section L02 \\
007 (Group 7) \\ \\
......@@ -20,6 +25,23 @@
\begin{document}
\pagenumbering{gobble}
\begin{table}[hp]
\caption{Revision History} \label{TblRevisionHistory}
\begin{tabularx}{\textwidth}{llX}
\toprule
\textbf{Date} & \textbf{Developer(s)} & \textbf{Change}\\
\midrule
Sept 28, 2016 & All & Created the Development Plan - Rev 0 \\
Oct 5, 2016 & Susan Yuen & Edited Development Plan to reflect decision to use Unreal Engine 4. \\
Oct 21, 2016 & Susan Yuen & Edited Development Plan to reflect decision to use XNA Game Studio and Visual Studio for development. \\
\bottomrule
\end{tabularx}
\end{table}
\newpage
\maketitle
\pagenumbering{gobble}
\newpage
......@@ -27,124 +49,86 @@
\section{Team Meeting Plan}
\begin{table}[h!]
\centering
\begin{tabular}{|c|c|p{4cm}|}
\hline
Week & Meeting Dates & \multicolumn{1}{|c|}{Meeting Agenda} \\
\hline
Sept 12 - Sept 18 &
\bigcell{c}{Sept 14: 10:30am-12:30pm \\ Sept 16: 8:30am-10:30pm}
& Formed the Blaze Brigade team. \\
\hline
Sept 19 - Sept 25 &
\bigcell{c}{Sept 21: 10:30am-12:30pm \\ Sept 23: 8:30am-10:30pm}
& Decided on the project and wrote the problem statement. \\
\hline
Sept 26 - Oct 2 &
\bigcell{c}{Sept 28: 10:30am-12:30pm \\ Sept 30: 8:30am-10:30pm}
& Created the development plan. \\
\hline
Oct 3 - Oct 9 &
\bigcell{c}{Oct 5: 10:30am-12:30pm \\ Oct 7: 8:30am-10:30pm}
& \\
\hline
Oct 10 - Oct 16 &
\bigcell{c}{Oct 12: 10:30am-12:30pm \\ Oct 14: 8:30am-10:30pm}
& \\
\hline
Oct 17 - Oct 23 &
\bigcell{c}{Oct 19: 10:30am-12:30pm \\ Oct 21: 8:30am-10:30pm}
& \\
\hline
Oct 24 - Oct 30 &
\bigcell{c}{Oct 26: 10:30am-12:30pm \\ Oct 28: 8:30am-10:30pm}
& \\
\hline
Oct 31 - Nov 6 &
\bigcell{c}{Nov 2: 10:30am-12:30pm \\ Nov 4: 8:30am-10:30pm}
& \\
\hline
Nov 7 - Nov 13 &
\bigcell{c}{Nov 9: 10:30am-12:30pm \\ Nov 11: 8:30am-10:30pm}
& \\
\hline
Nov 14 - Nov 20 &
\bigcell{c}{Nov 16: 10:30am-12:30pm \\ Nov 18: 8:30am-10:30pm}
& \\
\hline
Nov 21 - Nov 27 &
\bigcell{c}{Nov 23: 10:30am-12:30pm \\ Nov 25: 8:30am-10:30pm}
& \\
\hline
Nov 28 - Dec 4 &
\bigcell{c}{Nov 30: 10:30am-12:30pm \\ Dec 2: 8:30am-10:30pm}
& \\
\hline
Dec 4 - Dec 7 &
\bigcell{c}{Dec 7: 10:30am-12:30pm}
& \\
\hline
\end{tabular}
\end{table}
\begin{table}[h!]
\centering
\begin{tabular}{|c|c|p{4cm}|}
\hline
Week & Meeting Dates & \multicolumn{1}{|c|}{Meeting Agenda} \\
\hline
Sept 12 - Sept 18 & \bigcell{c}{Sept 14: 10:30am-12:30pm \\ Sept 16: 8:30am-10:30pm} & Formed the Blaze Brigade team. \\
\hline
Sept 19 - Sept 25 & \bigcell{c}{Sept 21: 10:30am-12:30pm \\ Sept 23: 8:30am-10:30pm} & Decided on the project and wrote the problem statement. \\
\hline
Sept 26 - Oct 2 & \bigcell{c}{Sept 28: 10:30am-12:30pm \\ Sept 30: 8:30am-10:30pm} & Created the development plan. \\
\hline
Oct 3 - Oct 9 &\bigcell{c}{Oct 5: 10:30am-12:30pm \\ Oct 7: 8:30am-10:30pm} & Created the Software Requirements Specification. \\
\hline
Oct 10 - Oct 16 & \bigcell{c}{Oct 12: 10:30am-12:30pm \\ Oct 14: 8:30am-10:30pm} & Began the Proof of Concept. \\
\hline
Oct 17 - Oct 23 & \bigcell{c}{Oct 19: 10:30am-12:30pm \\ Oct 21: 8:30am-10:30pm} & Finalized the Proof of Concept and began the Test Plan. \\
\hline
Oct 24 - Oct 30 & \bigcell{c}{Oct 26: 10:30am-12:30pm \\ Oct 28: 8:30am-10:30pm} & \\
\hline
Oct 31 - Nov 6 & \bigcell{c}{Nov 2: 10:30am-12:30pm \\ Nov 4: 8:30am-10:30pm} & \\
\hline
Nov 7 - Nov 13 & \bigcell{c}{Nov 9: 10:30am-12:30pm \\ Nov 11: 8:30am-10:30pm} & \\
\hline
Nov 14 - Nov 20 & \bigcell{c}{Nov 16: 10:30am-12:30pm \\ Nov 18: 8:30am-10:30pm} & \\
\hline
Nov 21 - Nov 27 & \bigcell{c}{Nov 23: 10:30am-12:30pm \\ Nov 25: 8:30am-10:30pm} & \\
\hline
Nov 28 - Dec 4 & \bigcell{c}{Nov 30: 10:30am-12:30pm \\ Dec 2: 8:30am-10:30pm} & \\
\hline
Dec 4 - Dec 7 & \bigcell{c}{Dec 7: 10:30am-12:30pm} & \\
\hline
\end{tabular}
\end{table}
\section{Team Communication Plan}
The team will use Skype and Facebook for communication outside of the agreed upon meeting times. These lines of communication are available when team members require assistance with their assigned work or require input from other team members on a topic of question.
The team will use Skype for communication outside of the agreed upon meeting times. These lines of communication are available when team members require assistance with their assigned work or require input from other team members on a topic of question. The team will also be using Slack to organize announcements regarding project development and deliverable deadlines.
\section{Team Member Roles}
\begin{itemize}
\item \textbf{Thien Trandinh}: Gameplay Mechanic, Developer
\item \textbf{Asad Mansoor}: Product Architect, Tester, Developer
\item \textbf{Susan Yuen}: Git Master, Graphic Designer, Developer
\item \textbf{Jeremy Klotz}: Algorithms Specialist, Scribe, Developer
\item \textbf{Jeremy Klotz}: Algorithms Specialist, Developer
\item \textbf{Asad Mansoor}: Tester, Developer
\item \textbf{Thien Trandinh}: Gameplay Mechanic, Developer
\item \textbf{Susan Yuen}: Git Master, Product Architect, Developer
\end{itemize}
\section{Git Workflow Plan}
After considering the different types of workflows, we concluded that \textbf{centralized workflow} best fits the requirements of this project. This is due to the fact that the project is relatively small - only spanning 12 weeks, and the team will see the project through from start to finish over this time period. As such, a release branch separate from a development branch is not necessary. In addition, team members will be working on aspects of the game pertaining to the same feature or features that rely on each other, so creating any additional feature branches are also unnecessary. Due to these reasons, feature-branch and gitflow are excluded. As a result, we decided on maintaining only one branch, and are thus implementing the centralized workflow for our project. Labels will be used to label any commits containing documents that are graded.
\section{Proof of Concept Demonstration Plan}
The proof of concept demonstration shall consist of the layout of the software architecture, including the skeleton of the majority of classes, functions, and implementation of the Model-View-Controller software design. The program shall have a working grid implemented, as well click detection and mouse functionality. The game shall also have one unit, which the player shall be able to move by first selecting the unit, then selecting another position on the grid to move the unit to. The player shall also be able to select and deselect the unit by clicking on the unit repeatedly.
\subsection*{Will a part of the implementation be difficult?}
There is no significant risk other than implementing all minor details within the given time constraint. \\
\subsection*{Will testing be difficult?}
Testing will not be difficult as the team members have experience with unit testing in frameworks such as JUnit. Our project will be coded in C++, and we will be using CUnit as our unit testing framework, which has similar concepts to our previous experience with JUnit. As such, our automated unit tests will be able to cover blackbox testing of functions and state variables using this testing framework. \\
Testing will not be difficult as the team members have experience with unit testing in frameworks such as JUnit. Although our project will be coded in C\#, the unit tests will share similar concepts and ideas to our previous experience with JUnit. As such, our automated unit tests will be able to cover whitebox testing of single functions and state variables. \\
\subsection*{Is a required library difficult to install?}
Libraries to be determined (Oxygine?) \\
No. The programs that will be used to develop, which include Visual Studio 2015 and XNA Game Studio, are available for free download to students in McMaster's Software and Computing Department. The downloads are available online through McMaster's CAS department. \\
\subsection*{Will portability be a concern?}
Portability will not be a concern, as a makefile will be provided in order to execute the C++ game on all 3 major platforms - PC, Mac, and Linux.
Portability will be a concern as the platform that the game supports only includes Windows, due to the restriction of the software the game is developed with. Visual Studio and XNA Game Studio are supported by Microsoft, therefore the game will only be able to support Windows devices.
\section{Technology}
\begin{itemize}
\item \textbf{Programming Language}: C++
\item \textbf{IDE}: Visual Studio 2015
\item \textbf{Testing Framework}: CUnit
\item \textbf{Testing Framework}: LaTeX
\item \textbf{Other}: Git, Photoshop
\item \textbf{Programming Language}: C\#
\item \textbf{IDE}: Visual Studio 2015, XNA Game Studio
\item \textbf{Testing Framework}: Visual Studio Unit Testing Framework
\item \textbf{Documentation}: LaTeX
\item \textbf{Other}: Git, Photoshop
\end{itemize}
\section{Coding Style}
%% There's a typo on this line of the pdf (it says "Googles" not "Google's")
%% the ’ character is NOT the ' character, and LaTeX doesn't render the ’ correctly
The coding style for the project will follow Google’s C++ coding style guide (https://google.github.io/styleguide/cppguide.html).
The coding style for the project will follow Microsoft's C\# Programming Guide (https://msdn.microsoft.com/en-us/library/ff926074.aspx).
\section{Project Schedule}
Please refer to the .gan file for access to the project Gantt Chart.
\section{Project Review (for Revision 1)}
\end{document}
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment