vsbabu.org

Practical outline for doing documentation

Evolt.org has an article about documentation. It is mostly an outline about outlines required for documentation. Good start for people thinking about how to get something going.

In my opinion, template driven projects are more usable and have better chance at being successful. Another important feature any product should’ve is the ability to copy and paste or still better, to clone one object in one click. This is especially true in web where you can’t copy-paste one full record in a form.

Minimum outline for any project should be:
- Think about the required elements
- Develop templates encompassing these
- Develop a checklist for different tasks you envision in the project
- Develop a workflow based on the checklist
- Design or document how to handle exceptions! In any project, there will be exceptions. In web projects, exceptions are omnipresent because every one has opinion about how it should look like and nobody likes to hear about order and standards. Any application is really defining order and standards and structure.

Then make an application to automate and validate as many of
the above as possible. If you get time, add in features like cloning objects.