Documenting a Web Page

Educational Function

Describing the Product. A technical description is usually broken into two major sections: the overall description and the description of the sub parts. In a web page, for example, you would explain the purpose of the site and then you would describe the various pages of the site and explain how they are related to each other. Then you would describe each page in the order you would normally expect a user to encounter them or in the logical order of their hierarchial relationship to each other.

Giving Instructions. The client may need to know several things about how to use the product. Perhaps the product needs to be assembled or set up. With a web page, a client may need to know how to "hang" the page, that is how to put itn on the web, but generally that process is even more mysterious than creating a page, so a client isn't likely to be able to do it. More likely is the client's need to know where the links are and how to activate them. They might need to know how to update the site or edit it.

Promotional Function