Top 3 tips to Great Technical Writing Improve Your Readers Access With A Visual Index

Outline 

Individuals are visual animals. They take a gander at your item and see, for instance, a catch or show. They need to get some answers concerning that control or marker. A Visual Index is a straightforward, however incredible, report access instrument that empowers your perusers to discover the data they need. 

This article depicts the Visual Index idea and advises how to make one for your record. 

 

A VISUAL INDEX 

A Visual Index is an image of your item or cycle with connections to the applicable data in the connected report. Utilizing a Visual Index, your Readers can glance at the image and rapidly leap to the spot in your report that portrays the thing of interest. 

Your archive may incorporate a few Visual Indexes (the plural of "list' is "records," not "files"). 

 

STARTS WITH A PICTURE 

The Visual Index begins with an image of your item or cycle. There are different sorts of pictures to utilize because of the item type: 

* Physical Product (for instance, a grill or video circle recorder) 

Photos of the item (all significant perspectives). 

* A Procedure or Process: A flowchart of the means and choices in the methodology or cycle. 

* Software Product 1: Screenshots of the product. 

* Software Product 2: Before and after pictures of the work that the item does. 

* Organization: An association outline. 

 

Name THE PICTURE 

Mark every one of the User-Product Interaction Points (U-PIP) on the image. A U-PIP is any place that your User and the item may communicate. U-PIP's incorporate controls, shows, and important actual highlights of the item (like handles, locks, and so on). Give a significant (to your Reader) (name) for the U-PIP. (Utilize that equivalent mark wherever you allude to that U-PIP.) 

Aside: If your item utilizes sounds to illuminate the User, then, at that point, incorporate a table of those sounds, what they mean, and a connection into the important space of your record (depicting the sound). 

 

Connection THE U-PIP's TO YOUR DOCUMENT 

As yet, the Visual Index is very much like any all-around marked image of your item or cycle. Notwithstanding, when you add connects to your report, the marked picture turns into a Visual Index. 

The connection ought to be to a part of your archive that you accept your peruser would most need to reach to get the data about that U-PIP. (This is a basic inquiry at whatever point you make a list: "does my peruser need to result in these present circumstances place in my report for this thing?") 

 

Your technique for adding connections to the image relies on the distributing system for the record. If the report is distributed as: 

* A printed archive, then, at that point, use page numbers for the connections; 

* An Electronic Document, then, at that point, use hyperlinks that a Reader can tap on to follow. Assuming the archive is distributed as HTML, the visual record can be a picture map. 

 

Model 1: A PAIN IN MY FOOT 

I have agony in my foot when I walk. On the off chance that I go to a site about feet, it would be extremely effective to get answers concerning my agony and see an image of a foot with different regions where the torment could be. Connections from the foot regions to explicit site pages would rapidly empower me to discover data about my particular foot torment. 

 

Model 2: PHOTO CORRECTING SOFTWARE 

Show an image with the blunders that your product can deal with prior and then afterward adjustment. Here the U-PIP's are every one of the photograph blunders. 

 

Model 3: A COURSE ON WRITING USER DOCUMENTATION 

The Visual Index is a flowchart for making the User Document. Since the Course is introduced in HTML, the Visual Index is produced using a picture map, with hyperlinks into the Course areas pertinent to everything in the flowchart. 

A Visual Index is a straightforward idea. In any case, in the same way as other straightforward ideas, it is exceptionally incredible. Attempt to remember one for your next report. You'll do your Reader an incredible help.

Enjoyed this article? Stay informed by joining our newsletter!

Comments

You must be logged in to post a comment.

About Author