Planning Changes
Planning changes is crucial for ensuring that development efforts are aligned with project goals and timelines. It helps in identifying potential risks and dependencies early on, allowing for better resource allocation and prioritization.
Example: Here is a link to a issue I made showing how I planned fixing a sprite issue with the platformer game
Checklists
Checklists are important for keeping track of tasks and ensuring that nothing is overlooked during the development process. They help maintain consistency and quality by providing a clear set of criteria to be met.
Example: Here is a checklist I made covering everything I did in the second trimester in CSSE!
Burndowns
Burndown charts are used to visualize the progress of a project over time. They help in tracking the completion of tasks against the project timeline, making it easier to identify any deviations from the plan and take corrective actions.
Example: Burndown lists helped keep me on track throughout the month we spent editing the RPG game. Here it is below!
Coding with Comments
Adding comments to code is essential for maintaining readability and understanding. Comments provide context and explanations for complex logic, making it easier for other developers (and your future self) to understand and maintain the code.
Example:
Below is a codecell showing some well commented code explaining how the lumberjack question function works in my rpg game
handleLumberjackQuiz(event) {
if (event.key === 'e' || event.key === 'u') {
// Find the lumberjack object from the list of objects
const lumberjack = this.objects.find(obj => obj.data.id === 'Lumberjack');
// Find the tree instance from GameEnv.gameObjects
const tree = GameEnv.gameObjects.find(obj => obj instanceof Tree);
if (lumberjack && tree) {
// Get the quiz question from the lumberjack's data
const question = lumberjack.data.quiz.questions[0];
// Prompt the player with the quiz question and get their answer
const answer = prompt(`${lumberjack.data.quiz.title}\n${question}`);
if (answer === '1') {
// If the player answers "1", chop the tree
alert("The tree was chopped down!");
tree.chopTree(); // Call chopTree on the actual tree instance
} else if (answer === '2') {
// If the player answers "2", do not chop the tree
alert("The tree was not chopped down.");
} else {
// If the player provides an invalid response, show an error message
alert("Invalid response. Please answer with 1 or 2.");
}
}
}
}
Building Development Help Documentation
Development help documentation is vital for providing guidance and support to developers. It includes instructions, best practices, and troubleshooting tips, which help in reducing onboarding time and improving overall productivity.
Example: I have created a help system for the Platformer game which can be found here:
Building a Lesson
Creating lessons is important for knowledge sharing and skill development within the team. Lessons help in standardizing practices and ensuring that all team members are equipped with the necessary knowledge to perform their tasks effectively.
Example:
I created a lesson on how we could use mathematical operators in our personal rpg. Check it out!