This is an archive site. For the recent posts, visit orderedlist.com.

Ordered List

OrderedList

Apr 11 2005

Documentation Process

The more I develop web applications, or even XHTML/CSS templates, the more I realize the need for project documentation. The problem is, I haven’t found an easy or efficient way to provide this documentation to the client. So this post is more of a question on which I intend to write a follow-up article.

How do you document your deliverables? What processes do you use? What formats to you provide? I’m interested to hear what the general community thinks about the need for documentation.

Clarification: I would like to set the focus on the documentation of the deliverables, aka the help documents. The ‘manuals’ if you will. What level of depth do your projects help documents require, and would you find a more automated, online version of help documentation useful?