Chapter 6: Docuphobia

---

 Download CD Content

Description

Poor documentation is a common contributor to bugs and a hindrance to code reuse. While perfect documentation is a practical impossibility, much of the current documentation does not even reach the rating of passable. The largest problem is not bad documentation, but no documentation at all. Many programmers have an aversion to writing prose; they might have even taken up programming to avoid it in the first place. Nevertheless, the fact remains that documentation is important to the software development process, particularly when working in a team environment. This documentation does not have to be Shakespeare, but it must be written to help others understand your code.

---