When putting together my last special and unrequested/unscheduled project for the data center that I worked for, I realized that I had to come up with documentation for the system that I created. I wrote a batch file that created other batch files for a special application that is used on a monthly basis. As I was finishing up, I started creating documentation so that after I left the company, others would be able to use the batch file with little or no problems/questions. If all you do is create something with little or no documentation, you leave others at the mercy of your work. I chose to take the upper high road on this and make documentation on the system I created. I call it a system (batch file) because of what it’s purpose was. The end purpose of the system or batch file was to elevate the need to manually create the necessary needed batch files in the event new one’s would have be created (This system is only used in this situation.).
I tried to cover as much information as I could so as to prevent any unforeseen questions or issues from coming up later. This is a hard thing to do. I created two different forms of documentation. A doc file that can be viewed by anyone who needs to know anything about the system and a special hard copy version with extra information. The system or batch file also has notes / comments within the bat file for easy reference. The more documentation available the more others are able to work with newly created applications.
See also: Instructions and Documentation Woes
Posted by Tim 
