Re: Icons in procedures

Subject: Re: Icons in procedures
From: "Marc A. Santacroce" <epubs -at- ricochet -dot- net>
To: Robert Heath <rheath -at- eGain -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 29 Jan 2000 07:38:30 -0800


I've seen it both ways, both work (with the 'in margin' icons larger than the 'in line' icons, of course).

I think it's a matter of personal preference and consistency with your other corporate docs.

P.S. You can't be too much of a rookie asking this depth of question.


Robert Heath wrote

I'm editing a large number of procedures that involve the user clicking
icons on a GUI. The icons are small, fitting in an anchored frame of 0.324"
by 0.304" in FrameMaker. The document I am working on was converted from
RoboHelp to Word to FrameMaker. In the help files, the author originally
placed the icons in the line which discussed them. For example, "Click the
Delete Category icon <icon here>."

As you know if you work in FrameMaker, placing graphics at an insertion
point works if the graphic is small; otherwise, it lies over text in the
line above it. So, I have been placing the icons next to the procedures in
anchored frames set to Run Into Paragraph. I thought it looked OK, but some
reviewers had reservations.

I have thought about making full screenshots of the the windows where the
user performs the procedures and placing callouts that point to the various
icons. I am under a tight deadline, however, and have to finish editing six
of these 15 to 142 page docs by 2/7. Does anyone have advice for displaying
icons for procedures?

Nearing the end of my first year as a tech writer and still very much a

Marc A. Santacroce

Senior Technical Writer
ePubs, Inc.

"An idiot with a computer is a better, faster idiot."

Previous by Author: Disappearing Cross references
Next by Author: Re: Adobe Framemaker
Previous by Thread: Icons in procedures
Next by Thread: Re: techwr-l digest: January 27, 2000

What this post helpful? Share it with friends and colleagues:

Sponsored Ads