Skip to main content

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


OVERVIEW

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

Discover What Good Writing Is All About

Writing is a form of preserved talk, talk that has been pinned down on paper so the words can be heard again. The basic principles of good writing, apart, from grammatical correctness, might be presented as follows:

1) written sentences should sound like natural speech;

2) the words we use must be exact, fresh, full of strength and vitality. Picture making words are better than vague, general words;

3) fresh point of view will give flavor to the style;

4) humor will lighten it.

Though, it is true that written sentences should sound like natural speech, they fully present an image of the natural speech. The reasons for this are fairly obvious: natural speech is a great deal more than words; it is also tone of voice, facial expression, gestures, and even the speaker’s appearance.

The whole point of writing is to create something better than we really talk – something more interesting, more thoughtful, and more effective in every way, for “effectiveness is what matters, and if an expres…

Article Submissions - Pointing You in the Right Direction

All of you who have been thinking of publishing articles probably seem to be noticing a lot more ads showing up when you search Google for article submission sites. So what does this all mean for you?

Well it leaves you the choice of where you wish to submit your article to. Lately new software is out that can let people get an article directory up and running in just a couple of hours and it seems every little fish wants a piece of the action.

So how do you choose the correct article directory for your article submission?

Here are a few tips to get you in the right direction:

Design - You probably are asking yourself why the design of the article directory has anything to do with how good this directory is for you. Well it is, it shows how serious the owners of the site are taking it - the more professional and maintained it looks the longer the site will be online and the more popularity it will gain.

RSS Feeds - Make sure the article directory you are submitting your article to h…

Marketing for Writers When Writing Just Isn't Enough

Many writers write for the experience.

Others dream of having a number one best seller. Both are wonderful reasons for writing. What many fail to realize is that these two do not have to be mutually exclusive. With a little research, you can enjoy writing incredible stories and see to it that they generate a profit.

The first thing that is needed is a business like attitude toward the process. From day one you must:

1) Know your niche.
Research which books are popular in your genre. Go to bookstores and start reading popular authors in your field. Also pick up writing magazines and see what publishers are looking for today.

2) Know your audience. If you are writing for children, for example, know the developmental stage that a child reading your book needs to be and cater to them.

Ex. A five year old would not be a good candidate for a chapter book.

You can also talk to your future readers and find out what really sparks their interest.

Ex. If you are a sci-fi writer, you can go into…

How A Sense Of Wonder Makes Life Richer

It always amazes me when I meet someone who has a disdain for expansion of knowledge.

The other day, over lunch, I was arguing with a girl about a principle of abundance. I illustrated this principle with anecdotes about historically famous millionaires who had applied this principle successfully.

Her response: “I can't use this information. It doesn't come from my experience.”

Since her idea of reality was only what fell into her immediate experience she was discounting the possibility of knowing anything outside it. Yet, unless she was willing to acknowledge the possibility of something outside her immediate circle of influence, how could she invite the actuality of the experience. Unless one has a hypothesis, experimentation is not an option.

Here is another example. During a certain period of time, a friend of mine and I, while working and living in similar circumstances, developed a completely different view of reality. During this time, I read books on super-string theo…

Learn To Trust That Gut-Feeling

It just might save your life
Think of the many times throughout your life when you experienced a strange feeling that turned out to be an early warning of danger.

Use your early-warning radar.

Did you take heed of that warning and avoid the impending danger, or did you ignore your built-in early warning radar and walk right into harm's-way?

The funny feeling in the pit of your stomach or the feeling of the hairs on the back of your neck standing on end are ways of your body telling you that something is very wrong.

Any veteran police officer or soldier who's seen combat and lived to tell about it will explain that part of their survival was due to trusting their "gut-feeling" that they were in danger.

Here's how it works:
There is nothing magical about this sixth-sense. It's simply your body's first reaction to adrenaline entering your blood stream.

As your digestive system is being shut down to allow more blood to flow to your muscles, you get a queasy …

7 Blocks To Creative Thinking And How To Solve Them

Each of us has the power to be creative. It's part of our natural make-up as human beings. The trouble is that, too often, we block our natural creativity and so make errors in thinking and give ourselves more problems than we should. Here are 7 ways to open up your natural creativity and keep the channels unblocked.

1. Don't Make Assumptions. When we assume, we often make an "ass" out of "u" and "me". Assumptions are examples of lazy thinking. We simply don't wait to get all the information we need to come to the right conclusions. There is the story of the customer at the bank who after cashing a cheque and turning to leave, returns and says: "Excuse me, I think you made a mistake." The cashier responds, "I'm sorry but there's nothing I can do. You should have counted it. Once you walk away we are no longer responsible." Whereupon the customer replies: "Well, okay. Thanks for the extra $20."
Tip: When y…