| Home | About | Concept | It's a Jungle | What you need to know | Services | Auth. Entry | Contact Us |
The User Manual (See Documentation: Part One) is not the only documentation required for a successful project. While the User Manual tells what the product does, it does not describe how the task is accomplished. Nor does it suggest how the product should be modified to accommodate new requirements. Without more, maintaining the product becomes a risky endeavor that introduces bugs and limits the product's lifetime.
The Technical Manual, unfortunately, is not as easily defined as the User Manual. Technologies differ widely, every product has its own logic, and each is best described in its own way. There is no simple recipe for providing the information that will allow someone to come quickly up to speed on an unfamiliar product. Merely defining the functioning of individual modules will not suffice.
The solution is to ensure that your developer possesses excellent written communication skills and has the inclination to use them. A product that is great one day and obsolete the next is no bargain!