Skip to main content

Great Technical Writing: Improve Your Readers' Access With A Visual Index



People are visual creatures. They look at your product, and see, for example, a button or display. They want to find out about that control or indicator. A Visual Index is a simple but powerful document access tool that enables your Readers to find the information that they want.

This article describes the Visual Index concept and tells how to create one for your document.

A VISUAL INDEX

A Visual Index is a picture of your product or process with links to the relevant information in the related document. Using a Visual Index, your Readers can look at the picture, and quickly jump to the place in your document that describes the item of interest.

Your document may include several Visual Indexes (the plural of "index' is "indexes" not "indices").

STARTS WITH A PICTURE

The Visual Index starts with a picture of your product or process. There are various kinds of pictures to use, based on the product type:

* Physical Product (for example, a barbecue or video disk recorder)
Pictures of the product (all relevant views).

* A Procedure or Process: A flowchart of the steps and decisions in the procedure or process.

* Software Product 1: Screenshots of the software.

* Software Product 2: Before and after images of the work that the product does.

* Organization: An organization chart.

LABEL THE PICTURE

Label all the User-Product Interaction Points (U-PIP) on the picture. A U-PIP is anywhere that your User and the product may interact. U-PIP's include controls, displays, and relevant physical features of the product (such as handles, latches, etc.). Provide a meaningful (to your Reader) label (name) for the U-PIP. (Use that same exact label everywhere you refer to that U-PIP.)

Aside: If your product uses sounds to inform the User, then include a table of those sounds, what they mean, and a link into the relevant area of your document (describing the sound).

LINK THE 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. However, when you add links into your document, the well-labeled picture becomes a Visual Index.

The link should be to a section of your document that you believe your reader would most want to reach to get the information about that U-PIP. (This is a fundamental question whenever you create an index: "does my reader want to come to this place in my document for this item?")

Your method of adding links to the picture depends upon the publishing mechanism for the document. If the document is published as:

* A Printed document, then use page numbers for the links;

* An Electronic Document, then use hyperlinks that a Reader can click on to follow. If the document is published as HTML, then the visual index can be an image map.

EXAMPLE 1: A PAIN IN MY FOOT

I have a pain in my foot when I walk. If I go to a website about feet, it would be very efficient for finding out about my pain, if I could see a picture of a foot with various areas where the pain could be. Links from the foot areas to specific web pages would enable me to find the information about my specific foot pain quickly.

EXAMPLE 2: PHOTO CORRECTING SOFTWARE

Show a picture with the errors that your software can handle, before and after correction. Here the U-PIP's are each of the photo errors.

EXAMPLE 3: A COURSE ON WRITING USER DOCUMENTATION

The Visual Index is a flowchart for creating the User Document. Since the Course is presented in HTML, the Visual Index is made from an image map, with hyperlinks into the sections of the Course relevant to each item in the flowchart.

BOTTOM LINE

A Visual Index is a simple concept. But like many simple concepts it is very powerful. Try to include one in your next document. You'll be doing your Reader a great service.

Comments

Popular posts from this blog

Top 10 [FREE] Writing Courses on Youtube That Are Packed With Massive Value

This is a friendly reminder that the best things in life really are FREE, and that includes full spectrum writing courses on Youtube that teach you just about everything you will need to know about operating as a competent, reliable, and skilled copywriter. Sure, you could pay for courses and there's nothing wrong with that. But why not take advantage of a free opportunity? Here are  Top 20 [FREE] Writing Courses on Youtube That Are Packed With Massive Value. 1. Simple Learning's Copywriting Course In this course, writers will learn how to write write product descriptions, multiply sales, and how to influence your readers. Course contains very little fluff - only the most important principles are shared throughout the video.  2. Simplilearn's Full Course Content Marketing Tutorial For Beginners Every content writer and marketer wants that coveted #1 spot on Google. Heck, most want to get to the front page at the very least. This course is all about ranking high on Google an

How To Get People To Know That Your Book Is Out There

Ok, so you wrote that perfect novel, and rewrote it again and again until it's perfect.  Then you found either a Publisher or Agent to represent you.  Your book has been through the editing stage, cover art finalized, and a published Date assigned, now what?  Is the job done?  Have you did all you needed to do to make this book a success?  Nope, you have only begun.  Now you have to market that book, get  it into book stores, let people know it is available.  First off, you need to find out from your Publisher or Agent where you book will be available, who is doing reviews and any promoting they plan on doing.  Once you have the answers to these questions you now know where to start.  A review is the first step to getting your book known.  You can begin requesting reviews as soon as the Publisher has a final proof copy available.  Most review sites can be found in the Search Engines by simply typing the genre of your book. Examples includes romance and sci-fi, and book r

How to Multiply Your Freelance Work

You can turn your $200 fee to write a press release into $2,000 to  carry out an entire PR campaign simply by convincing clients to  invest in campaigns, instead of individual assignments. Campaigns  achieve better results and cost less in the long-term for clients, compared to individual assignments. And, of course, as the  freelancer, you get paid much more for turning out a succession of  assignments that assimilate a successful campaign. Here's how to multiply your writing sales by convincing clients to  invest in long-term campaigns, instead of short-term individual  assignments. • Know the short-term and long-term results. A client approaches you to write a brochure. He may or may not know that his product can  also benefit from other types of promotional pieces, such as ads,  direct mail, news releases, websites, and so on, to sell his product  or service. Your job is to educate the client. The brochure may be  the first promotional piece in a consortium of promotion