TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: How to reference screen captures in online help
Subject:Re: How to reference screen captures in online help From:Mike Stockman <stockman -at- JAGUNET -dot- COM> Date:Wed, 10 Mar 1999 11:11:07 -0500
On 3/10/99 10:45 AM, Michelle Vina-Baltsas
(Michelle_Vina-Baltsas -at- US -dot- CRAWCO -dot- COM) wrote:
>I'm stuck on this, so I figured I'd ask the experts what they do. How do
>you all reference screen captures in your help files? Traditionally, I
>have used something like this, "The XYZ sample window is shown below.", but
>I'm wondering if anyone else has any other suggestions. Also, for those of
>you who add hotspots to your screen captures, how do you reference them in
>your help file?
I've generally avoided "below" in descriptions, which is a habit left
over from my printed manual days. An illustration or screenshot may
appear physically below the text, but it may also appear at the top of
the next page due to the joys of pagination. Since "below" would not be
accurate there, I've used different methods, as shown in these absurd
This example shows how to enter your first name in the First Name
or, in a procedure:
1. Enter your first name in the First Name field, as shown here:
or, when I think the graphic is a clear example of what I've described:
1. Enter your first name in the First Name field.
<graphic goes here without any additional explanation>
For hotspots, I've always introduced the graphic and concluded with
something like "Click any field or button in this example for a
I think some variety in wording helps keep the doc. from sounding boring,
but these are the general sentences I've used...