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.
>>One good solution is to use the text name (e.g. "Click the Save As
icon") for the icon in the text, then place the icon itself in the left
margin to provide a visual reminder. Arguably the most effective
approach is to provide a screenshot of the interface, and define the
procedure as a series of numbered callouts, arranged in logical order
(top to bottom, or clockwise around the screenshot). The effectiveness
of this approach has been demonstrated quite convincingly in some Dutch
studies. (By van der Meij?) I plan to use that approach in a book on
onscreen editing I'm currently developing.>>
Screen shots are beautiful things, but they're a huge problem if you're
translating documentation for the simple reason that they can't be
translated. I would avoid painting your documentation into a corner by
filling it with screen shots, especially if you need I18N. It will break
your translation budget. Using only icons, or when necessary, icons with
amplifying text, is more cost efficient for translation. Furthermore,
screen shots are high maintenance because developers can change them
faster than we can snap them.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
