Documentation

There is sexy and there is unsexy and documentation has got to be in the unsexy camp. It is dull, it is boring, and nobody wants to do it but good documentation also comes with a lot of benefits.

• Your employees do not need to be mind readers - A well documented computer program means the people who are going to modify the code do not need to be mind readers. They are told what the program does, the functions that the program contains and other important information such as the author of the code and what package the code belongs to
• Training times are reduced. - Good documentation allows people to quickly find what they want, which means that you can spend less time having to train them
• You save money - There is a saying that states "time is money", so any time you save means that you are actually saving money
• You look good - Web-D-Zine( WDZ ) has been produced by two people who live on a boat, but if you look at our code and our documentation, you would think that we were a mega corporation. I know our documentation makes us look good, so lets spread the love and make you look good

So how do we have great documentation?

We get the computer to do it. If you have a dog, why bark. When the code is being generated we use industry standard php doc tags like:-

• @author - Specifies the author of the code
• @package - States what package the code is part of
• @var - Variable
• @return - What the function returns etc.