Tips for Complex Programming Assignments
Understanding the Importance of Planning and Documentation
Jul 15, 2009
Most beginning programmers studying in college get a programming assignment and jump straight onto a computer and code away, which is fine for basic programming classes. These programmers will soon discover, however, that programs and ideas become too complex for them to complete without some sort of plan.
Plan out the Program
Before a feature film is created, it is storyboarded; before a novel is written, its characters and plot have to be brainstormed: programming is no different. In order to successfully make the transition from small, simple ‘Hello World’ programs to more complex systems, programmers must learn the value of planning out the logic and documenting their work. One of the best places to start is with a design document – the beginning of external documentation.
External Documentation
Documentation is just that, those working on the project document how it was created and how it can be used. A common form of external documentation is an instruction manual, which describes how the system can be used, or design documents, describing how the system will be created. Understanding the logic of the program and mapping out the program on paper will help programmers plan out a clean, structured system.
Taking the time to produce a design document will save time in the long run, as beginning programmers will then have a plan to refer to in case their program doesn’t work. It will also allow other programmers who work on the system or code to understand the logic used to create a program.
Internal Documentation
It may be difficult for beginning programmers to understand the importance of internal documentation when working on simple, one-man projects, but internal documentation is just as important as external documentation. Rarely, if ever, will programmers in their field of work be alone on a project. Programmers usually work in teams, meaning many people will have to read and understand the code written.
While a design document help team members understand the structure of the code, internal documentation – such as appropriately named variables or internal comments explaining code sections – will increase efficiency in peer review of programs, so it is important that programmers get in the habit of internally documenting work, even if it seems useless.
Not only will internal documentation help others review their work, but it can also be beneficial to the programmers themselves. Simple to understand variable names help programmers follow the logic of their program, while internal comments can be useful in fixing bugs or in helping with modifications.
Conclusion
Poorly documented programs, even if they are brilliant and innovative, will destroy the entire project before it reaches fruition. If other programmers cannot follow the logic, or if users are unable to use the system, then it becomes useless.
Programming is much more than typing in code: programmers must be able to plan out their program logic using a design document and create external and internal documentation. Following these simple steps will ensure programmers will be more successful in their complex programming assignments and be better prepared to engage in team projects once they begin their career.
 |
 |
