Table of Contents
Project Management
A. Team working agreement- agreement on how work will be completed
B. Individual Responsibility agreement- what tasks each member will be responsible for
C. Project schedule- dates for when each project task was completed
D. Meeting notes- anytime the group met in person, it is addressed in this section
Business Plan
A. User Identification and Interviews- interviews players of the game
B. Electronic/Print advertisement for the game- and ad for the game
C. 30 second to 1 minute pitch video/advertisement for the game- demonstrates the game and explains how it works
Software Documentation
A. Introduction- introduces the software documentation section
B. User Manual- describes then game to the general audience
C. Program Description for Developers- commands and variable names used in the code
D. Final Algorithm, Flowchart or Pseudocode- algorithm/flowchart used for final code of game
E. Final Program with Comments- final code of game with comments
F. Brief Discussion- discusses problems in completing project and how they were solved
G. Conclusion and Recommendations- concludes project and offers improvements to the game
Executive Summary
As technology advances, coding becomes more important to many engineering careers. These coding languages range from MATLAB and Python, to Java and C++. As importance of coding in engineer rises in the field, the more prevalent it becomes in classes. One example of this is the Engineering 1181 Software Design Project. This project uses many engineering skills such as teamwork and problem solving but focuses on coding to create the project.
To begin the project, the team must decide on what game(s) to create. Team E decided on creating Hangman as its core game and connect four as its extra credit game. Interviews were then conducted with two different users to better understand how to create the games for MATLAB. After the games were chosen, responsibility for the code was agreed upon within the team. Keyi Lu and Matthew Taubeneck coded Hangman, while Mohith Kankanala and Raymond Bass coded Connect Four. The group members would work on the documentation for the game they helped coded as well. A team working agreement was also drafted, along with a project schedule to keep the team on task.
An electronic or print advertisement was then made for Hangman and put onto the team’s ose.edu website. Along with the advertisement, a pitch video was made. This video is between 30 seconds and a minute and describes how the game works and why people should play it. In the video, there is also a demonstration of Hangman so people unfamiliar of the game can see what it’s like.
In software documentation a user manual is created for the general audience that doesn’t know MATLAB. This user manual describes the steps in Hangman and how it works. This section doesn’t contain any MATLAB language unless it’s described in the user manual as well. Then a program description is made for the developers. This contains all commands and variable names for the code. For example, “wordList_hard” contains the words for the hard section of hangman. A final algorithm/flowchart is also put into software documentation. This final algorithm matches with final program and shows how the game works step-by-step. This section doesn’t contain code, only descriptions of the steps involved in the process of the game. Next is the final program. The final program contains all the code used in the final model of the game, along with comments from the creators to help other programmers understands what each piece of code performs. In the discussion section, the process of building the code and problem solving is analyzed. For example, Team E used the trial-and-error method to solve any problems within the code. Any obstacles faced are addressed in this section. In Conclusion and Recommendations, the project is concluded with overall goals and objectives presented throughout the working stage. Then any new ideas or fixes the team would give if given more time are addressed at the end of the conclusion. For example, the addition of a colored hangman picture of the game could i9mporve overall enjoyment of the users. References contain any external websites used to help complete the software design project.