Contact Us:

United States/Canada:
Toll Free: (800) 582-5167

Europe:
+44 (0)1582 638800
+49 30 921 241 09

Asia-Pacific:
+61 (02) 8916 6255

International:
+1 (410) 715-4226



Importance of Documentation

In a technological age where there’s custom tailored software to fit every problem, it is crucial to have proper documentation readily available to all IT staff within a company. Not only does this give another level of support to users, it provides crucial information for admins that are trying to set up a uniform environment across their domain or server farm.  

Let’s say you have five servers that have Simplify Suite, and for whatever reason the admin in charge is unavailable. If something goes awry or changes need to be made to the settings, your second in command will have to step in. They may have no idea as to how that admin has their Suite software set up and might be able to make the necessary changes, but will probably do it their own way, or waste time trying to figure out how the Simplify Suite settings are structured. Consequently, users experience down time or resources are wasted. All due to lack of proper documentation.  It is paramount that up-to-date documentation be available to all IT personnel in case of such a situation. Any kind of document that explains how to handle and work with certain settings, and how to stay within the bounds of the design of whatever hardware or software you are configuring/maintaining/or fixing will make all the difference.

I have seen varying successful solutions to the documentation issue. One is to have some kind of shared drive or folder that's dedicated to keeping an organized list of folders and files that have settings explanations, requirements, and dated track changes. Another great idea is to use a Wiki. It is similar to a shared drive or folder but has its information made public so IT staff can adjust and make changes without having to open multiple word files. Many companies already utilize Wikis, so this gives an even further use to an already great tool. I sympathize that at the time, making a doc feels aggravating and unimportant, but in the long run it has a big impact on everyone. If you can think of another way to share and keep information, share about it in the blog.

  

Nick Nikitkin  triCerat Inc  Technical Support