Search code examples
cssxhtmldocumentation

How to make maintaince document for a website?


How to make maintenance document for a website? I've created a site using XHTML ,CSS, jQuery etc. it's big site.

Now i have to write a maintenance document for a site for if any changes comes in future related to design, content and functionality then those things will be handled by someone else.

How and what should i keep in maintenance document.


Solution

  • Your maintenance document should contain a high-level design of what each file contains and the general code structure of the project.

    For example, if you wrote some javascript to handle certain events, document those and how they interact with the page.

    You should also document any logical groupings you've made. If a folder contains all the XHTML for a certain topic, write those down.

    Also give a brief explanation of how you used CSS to layout the page. Which classes are where on the page, and which classes or ids are important.