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.
Subject:Re: buttons graphics in documentation From:Barb Philbrick <caslonsvcs -at- IBM -dot- NET> Date:Wed, 24 Jun 1998 13:31:21 GMT
>Should little screenshots of icons and buttons be placed in-line in print
>documentation (not on-line)?
I've done this with positive results from readers and reviewers.
Things to keep in mind:
* Don't include text (that is, "the floobydust button, <icon>,")
unless you have a compelling reason. It's redundant and could be
confusing.
* If possible, change the background of the icons to white to limit
the contrast between the text and the icons. It also makes them print
more clearly, especially if you're printing to a low resolution
printer or if the material will be copied. (To do this in Windows, I
start with the High Contrast White and change the background of
buttons to white. I manually modify some icons using PhotoPaint.)
* Lower the icon on the line (I usually lower them about 6 pts) to
reduce the amount of influence on line spacing. Depending on the size
of the icon and your format, this can prevent any "weirdnesses" in
line spacing.
* Limit other formatting. When I first tried including icons, I was
also using bold and italics for some other items. The result was an
incredibly messy and confusing page. I reassessed what I was using the
formatting for and discovered that some of it wasn't necessary.
Hope this helps!
Barb
Barbara Philbrick, Caslon Services Inc.
Technical Writing. caslonsvcs -at- ibm -dot- net
Cleveland, OH