Outlining

Outlining of document is to create the Table of Content (TOC) with all the relevant information of the subject. It is an easy and a correct way to create a quality document. Creating TOC gives the road map of the document. It provides the clear image on what we are writing. On looking at the TOC, we will understand the topics that are needed to be covered, and the information required. This reaches towards the correct Subject Matter Experts (SME) to collect information.

Once the TOC is created and approved, the technical writer should develop a proper questionnaire to get information from the SMEs. The technical writer should first understand the subject. He/she should learn the subject from the existing document or from search engines. This is the healthy way to create a document. With the preliminary knowledge, the technical writer, with the questionnaire prepared, can have a brainstorming session with the SME’s. This will add the quality of the subject, and also interests the SME’s to provide more quality information.

In some cases, the technical writers will blindly stand before the SME’s for information. Sometimes, they will not know what exactly they wanted. Such type of people cannot be called as technical writers; they are just writers, as they write what the SMEs say. There is no need of a qualified people. Anyone who knows to write and read can do this job. The actual technical writer will dig through the information and identify the possible options to provide the maximum clear-cut valuable information for the customers.

Creating history is very good, but explaining the creation of history is very important. Otherwise, the creation itself will become unseen.