Latest posts by techwriter (see all)
- 101 Tips and Tutorials to Write Like a Pro - August 17, 2017
- How to Find a Technical Writing Job – Some Ideas and Resources - August 9, 2017
- BOOK REVIEW: “Design for How People Learn” by Julie Dirksen - July 10, 2017
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.