In Support Docs, Constant Improvement is Vital

WisTex's picture

Keeping support documentation updated can become a full time job, especially in the technology and internet arena, where change is constant. There are always new things coming out, and many changes here and there that effect support documentation.

It is not enough to write a piece of documentation once and forget about it. It is necessary to tweak and modify that documentation over time.

One of the techniques we use here at the Complete Hosting Guide is constant improvement.

When we write an article, that is not the end of it. We come back later the next day, the next week or even months later, and check to see if we still think that article is perfect.

No matter how many times you proofread the initial version, you are in a different state of mind later, and see things differently. Or a reader or customer may have asked something that made you realize the article could be better.

We often find minor things that need to be adjusted or tweaked. Maybe we forgot to mention something, or we realize that something we said is not clear, or something has changed, or we later realize that we made a mistake that needs to be fixed.

So, when we see something like that, we don't wait to fix it, we click on the edit button, and make the change.

Sometimes it's the small things that make the biggest differences in support documentation. And constantly improving your documentation through minor changes polishes it until it is a masterpiece.

About the Author

WisTex's picture
Scott M. Stolz

Recommended Content