I may not be in class this semester, but it sure does feel like I’m studying for an exam.
That’s what doing the documentation feels like. It reminds me of reviewing the little details you learn over the semester to make sure you understand them and how they relate to the other details. I thought doing documentation would be a matter of writing a few blurbs explaining what we made and how it works. But most of the time has been consulting the source code and my team mate to remind myself how a feature works. And I finish the documentation section with a much better understanding of what we created. It’s been a long time since September, and now I can view the design decisions we made in a new light.
The problems I’ve described aren’t major issues. They don’t impact the functionality of our creation, they just break standards (which, in our defense, we weren’t familiar with when we started) and cause some issues with maintainability. Luckily, this is CDOT. It’s open source. So the world can clean it up for us. (Thank you, world.) Or maybe we’ll even have some time for some cleanup before the end of the project.
One thing is for sure – I’ve learned a ton working on this project and I have no doubt that the code I write for web apps going forward is going to look a lot better than the code I produced in class before starting this project.