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.
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.
Great Technical Writing: The User-Product Life Cycle - A Documentation Tool
The User-Product Life Cycle (U-PLC) is a powerful tool for the User Document writer. Use the U-PLC to generate the high-level topics for your User Document.
Great Technical Writing: Tell Your Users What to Expect
In your User Documentation, you direct your Reader to perform tasks with your product. If you don't tell your Reader what to expect when performing those tasks, you will have a baffled Reader, resulting in dissatisfaction and expensive calls to technical support.
New Technical Writer: Conquering the Fear of Writing
Stepping into the role of a technical writer can be daunting, especially for those without a writing background. The task of creating User Documentation for a new product might stir up fear and anxiety, reminiscent of school days filled with writer's block and critical evaluations. However, writing for a user manual is a unique process that differs significantly from academic writing. This article aims to guide new technical writers through the process, providing strategies to overcome anxieties and produce effective documentation. With the right approach and resources, anyone can craft clear and helpful user guides.
