Case Study

Additionally, conduct interviews with users so as to get non-technical information on the topic that is being written about. An example of this is a technical document about software. Here, the users’ thoughts can help you know how to convey information to them about the specific software.

Next, you will need to develop an outline. This is the structure for how the document will be written. This should follow a logical sequence, indenting outline items so that related or related items all fall on the same level. Also be ready to make future revisions if necessary.

Start writing the document. Make sure that you keep the document clear and simple. This should be done especially where your target audience involves people who are non-technical. You can use the play script writing style for task oriented technical documents. This is the style where an item is written like the script of a play where there is a detailed step-by-step instruction detailing who performs each action. This system is extremely easy to understand. Insert all the relevant references in the document.

Make use of graphics. These break up the written technical information and make it easier to read. A commonly used form of graphic to consider is a flow chart which shows relevant items. Examples of what to put on a flow chat are the steps that are involved in a specific procedure. Other graphics that may apply may include product photos showing different views of the product.

Right now you have reached an especially important step. Get a competent editor and proof-reader who is knowledgeable in the field being written about to check your work. Be incredibly open to their suggestions. If the audiences targeted are end users, give an end user the document to read and give you reviews. The end user will help you tell if the product is easy to understand.