BLOG

Home Blog Details

images

23 Apr 2018

IT Support Documentatio

Documentation plays an important part in Information Technology. Work instructions, help desk scripts, knowledge bases, and vendor instructions are only a few examples.The key to writing good technical documentation is in the format of the document. No matter how good the information is, if it is not well formatted it can be difficult to use. Documentation should be easy to read, easy for the reader to understand and well organized. Writing good technical documentation is time consuming, but well worth the effort.Steps to Good DocumentationThere are some essential steps to take in order to produce quality documentation.What Is The Purpose?Determine what the purpose of the documentation is such as work instructions, vendor instructions, knowledge base or other type. This will help you define the content, the format and in some cases the media you will use.Who Are You Writing For?Knowing who will be reading the documentation will help you determine the depth and word usage. You want to write the documentation at the level of the person reading it.Collect InformationEven if you are an expert in the area gather all of the information you can find on the subject. You may need to interview or get the assistance of others to help you gather the needed information. Manuals, user guides and online resources are very useful.Write an OutlineStart with an outline of the document indentifying the different sections of the document. This will help guide you as you fill in the blank spaces with more detail.Write The First DraftWorking from the outline begin to fill in each section with details. Don’t worry about formatting or editing at this point. Here you want to get down all of the information that will be in the document.Revise and FormatNow it is time to polish the document and format it. A good rule of thumb is you will end up removing more than you add if you wrote the first draft correctly. Wait until you have a final draft before you format the document.The Four Essential PartsDepending on the subject most technical documentation should be broken down into four areas.TitleSectionStepsAppendix

comments
Akshay Kumar
JAN 20, 2018

Dserunt mollit anim id est laborum. Sed ut perspiciatis unde omniste magna natus error voluptatem dolor mque laudantium, totam rem aperiam, eaque ipsa quae duiad ab illo inventore.

Akshay Kumar
JAN 20, 2018

Dserunt mollit anim id est laborum. Sed ut perspiciatis unde omniste magna natus error voluptatem dolor mque laudantium, totam rem aperiam, eaque ipsa quae duiad ab illo inventore.

Akshay Kumar
JAN 20, 2018

Dserunt mollit anim id est laborum. Sed ut perspiciatis unde omniste magna natus error voluptatem dolor mque laudantium, totam rem aperiam, eaque ipsa quae duiad ab illo inventore.

Leave a Reply

ARCHIEVE