[thelist] Basic Documentation Questions

Bill Haenel bill at webmarketingworx.com
Fri Feb 8 12:38:12 CST 2002


> to me). For instance on a site that is built with mostly HTML how much
> documentation should be included? If the coding practices I am
> using are in
> line with the W3C standards (as much as possible) does that code need
> documenting? Or maybe only where I get away from the standards or do
> something more "creative"?

Generally speaking, documentation exists to define processes. After you
decide HOW something will be done process-wise, it is necessary to document
that process in order for others to be familiar with that process.

You might build a site to meet W3C specifications, but your specific process
for arriving at that site design or product may be different than mine. So,
you document your process to share it with others who need to know.

To further David's point (and now I understand why he made it):

> I'm painfully aware of how chaotic an application can become with little
or
> documentation while the project is in progress.

With a documented process, it is easy to determine how to get to your
destination. That is, provided someone has already been where you're going
and can provide good docs on how to get there easily (think Columbus).

BH

One more documentation link I found that is pretty comprehensive:
http://hds.essex.ac.uk/g2gp/digitising_history/sect51.asp - be sure to
follow the link within that page to Section 5.2.




More information about the thelist mailing list