Corwin Belser | PPJ Week 1: Spring Cleaning

WEEKLY NARRATIVE

My primary goal this week was to get our code base into a form that our new programmers can understand, allowing them to identify problem spots.  I had taken the lead on cleaning our Unity project at the end of last term, but did not have time to go through code cleanup.  I was surprised how much code we have that I hadn't looked through before, so much of my time was spent reading the source code to get a good understanding.

After sorting the scripts and removing a few I knew were no longer used, I created a doc to act as a documentation hub for our scripts.  An example of the format I created can be found below under Workflow Examples.

CONTENT WITH HOURS

• Sorted scripts (1 hours)
• Removed scripts not being used (1.5 hours)
• Documented all scripts (4 hours)
• Critique meeting (3 hours)
• Story design meeting (4 hours)

WORKFLOW EXAMPLES

Below is an example of the documentation format

Script Name As Link

Purpose:

Used By:

Author: Unknown

Requirements to use:

Implementation quirks:

POSITIVE OUTCOMES

• The Unity project looks clean. I am *very* happy about that
• I have a solid understanding of all of our code base now, which will be a major plus as programming lead

NEGATIVE OUTCOMES

• I don't think the documentation I created is going to be good going forward. It introduces overhead and requires updating something outside of the code.

NEXT TASKS

The next big task will be getting the programmers together to show what we have and get everyone on-boarded.  I'd also like to look into a tool to generate documentation from XML documentation comments that we are already using in our code.  This would greatly help us in keeping a documentation wiki for our team.

TOTAL HOURS LOGGED THIS WEEK: 13.5 hours

TAGS

#{Corwin Belser}

#{Week 1}

#{Documentation}
#{PPJ}
#{Programming}