How Great Technical Writing Improve Your Readers Access With A Visual Index

OVERVIEW People are visual brutes. They look at your product, and see, for illustration, a button or display. They want to find out about that control or index. A Visual Indicator is a simple but important document access tool that enables your Compendiums to find the information that they want. This composition describes the Visual Index conception and tells how to produce one for your document. A VISUAL Indicator A Visual Indicator is a picture of your product or process with links to the applicable information in the affiliated document. Using a Visual Index, your Compendiums can look at the picture, and snappily jump to the place in your document that describes the item of interest. Your document may include several Visual Indicators (the plural of indicator is indicators). There are colorful kinds of film land to use, grounded on the product type * Physical Product (for illustration, regale or videotape fragment archivist) Film land of the product (all applicable views).

* Software Product 1 Screenshots of the software. * Software Product 2 Before and after images of the work that the product does.

*Organizing a map Marker THE PICTURE Marker all the Stoner- Product Interaction Points (U-PIP) on the picture. AU-PIP is anywhere that your Stoner and the product may interact. U-PIP’s include controls, displays, and applicable physical features of the product (similar as handles, latches, etc.). Give a meaningful (to your Anthology) marker (name) for that U-PIP. (Use that same exact marker everyplace you relate to that U-PIP.) Away If your product uses sounds to inform the Stoner, also include a table of those sounds, what they mean, and a link into the applicable area of your document (describing the sound). LINK THAT U-PIP’s TO YOUR DOCUMENT Up to this point, the Visual Index is just like any well- labeled picture of your product or process. Still, when you add links into your document, the well- labeled picture becomes a Visual Indicator. The link should be to a section of your document that you believe your anthology would most want to reach to get the information about that U-PIP. (This is an abecedarian question whenever you produce an indicator does my anthology want to come to this place in my document for this item?”) Your system of adding links to the picture depends upon the publishing medium for the document. If the document is published as * A Published document, also use runner figures for the links; * An Electronic Document, also use hyperlinks Anthology can click on to follow. However, also the visual indicator can be an image chart, If the document is published as HTML. Illustration 1 A PAIN IN MY Bottom I've a pain in my bottom when I walk. However, it would be veritably effective for chancing out about my pain, if I could see a picture of a bottom with colorful areas where the pain could be, If I go to a website about bases. Links from the bottom areas to specific web runners would enable me to find the information about my specific bottom pain snappily. Illustration 2 Print CORRECTING SOFTWARE Show a picture with the crimes that your software can handle, ahead and after correction. Then that U-PIP’s are each of the print crimes. Illustration 3 A COURSE ON WRITING USER DOCUMENTATION The Visual Index is a flowchart for creating the Stoner Document. Since the course is presented in HTML, the Visual Index is made from an image chart, with hyperlinks into the sections of the course applicable to each item in the flowchart. A Visual Indicator is a simple conception. Try to include one in your coming document. You’ll be doing your Anthology a great service.

Enjoyed this article? Stay informed by joining our newsletter!

Comments

You must be logged in to post a comment.

About Author