Writing Technical Documentation

What should be included? Is it needed?

[Harvs]

About 4 months ago I was employed at a company to mantain their current website and also build a new website for new products. When over taking the old web site I found it annoying that there was no doucumentation reguarding the standards used or the way the site was put together. This has lead to the old site being writing in different languages in different places, file names looking different and other problems.

So for this new site I'm doing I thought it best to write some form of documentation as I create it so future web developers working on the site have a set of rules to work by.

I was hoping to get some sort of input into what should be included in technical documents. My short list included:

1. File naming rules
2. Directory Structure
3. Programs used (ie version numbers)

Any other areas people can think of?

[trillianjedi]

What you're creating is called a style guide.

Do a search for "style guide" and you'll locate quite a few of them for newspapers, websites etc. I would advise you have a read through other peoples, then you'll have a clearer idea of what will be useful in yours.

TJ