Documentation is only as good as the documentor

I’ve started working again in the computer field for another organization and I continue to see the importance of quality documentation. Haste definitely makes waste in this subject. When you are documenting something for others to be able to refer to later, you really need to be careful as to it’s quality and clarity.

Sometimes when you are paging through documentation, you can notice that some of the screen shots don’t make sense or that the ones used were from years past and should have been updated. It’s well worth the time and effort to take your time when creating documentation. Not doing so can have darts flying your way if you are not careful (figuratively speaking).

The documentor needs to think of those who will read the work later when needed. The closer to perfection the work, the more appreciated the documentation will be by those in need.

Granted the person doing the work may be really good in the given profession, but, if the work is done carelessly or haste fully, then what’s the point? It was a waist of time.

It pays to be diligent. Besides, what if the creator becomes the reader or worse, the one doing the presentation in front of a large group of people?

Leave a Reply