Why Application Documentation is so Important

Any application written, no matter how large or small needs documentation.  It doesn’t have to be fancy but the documentation must be written and it must be kept up to date – no exceptions.  The documentation can be as simple as a one page document that spells out to anyone who supports the application the following things:

  1. What the application does, how it works
  2. Who uses the application
  3. Where the application lives (server names/passwords)
  4. Databases it relies on (server names/passwords)

If this information is not documented (and the documentation not kept up to date), then troubleshooting the application may take hours which means the users are left waiting for (sometimes critical) applications to be fixed.

This is a typical scenario of what can happen when documentation is not updated (it happened to me yesterday):

We have a vendor written application that resides on two servers and it has several passwords and databases.  Years ago when I was a part of setting up this application, I documented everything about it.  I wrote a short one page document of all the critical stuff: how it worked, its databases, passwords, and server names.  Then, a few months ago, another team member upgraded this application and put the application and its databases on new servers.  Did this employee document any of this? No. Is this employee still with our company so I can ask him anything about this application? No.  Are we in a bind because of this? Yes.  Do you know why? Because the application went down yesterday.  We looked at the documentation I had written about the application and discovered it had not been updated so we didn’t know any of the new passwords for getting into the administrative side of the application; we actually had to hunt and peck through the registry to find this information.  Troubleshooting this application yesterday was a complete nightmare and it took several unnecessary hours.  If the documentation had been properly updated, it would have saved us hours of frustrating work.  The fix was something so simple (a particular executable had to be running 24/7 before the application would work and this executable had stopped due to the server getting hosed due to the a/c going out in the server room) but since no one had documented this new process, we had to figure it on the fly which kept our users waiting.

Many IT employees will complain that they do not have time to write documentation or update documentation.  The only reason they do not have time is because they either don’t make it a priority or the clients don’t understand the importance of the documentation.  IT has the power to address both of these issues head on by making documentation a priority and letting clients know that if they want fast service in a stable application environment, then documentation needs to be considered as important as the application itself.

Create a free website or blog at WordPress.com.

Up ↑