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.
I don't know what is preferred, I think it would depend on the readers,
the design, and layout.
When I was writing for translation I did one of two things:
1. Callouts with numbers on an area, with a table underneath the
picture. I made it LOOK like the picture and table were all one figure,
so it was Figure 1, Figure 2, with the table as text underneath - it was
easy to translate. We never had complaints about this, and reviewers
felt it was easy to follow.
2. LARGE schematics were handled on facing pages, figure X on one page,
callouts were numbers; Table X on facing page with the explanation
Text can always refer to the numbers, but unless there are very few
numbers/arrows, I would have the key separate, as people like to look at
figures and immediately understand what they are looking at.
For example, I had the two pager mentioned above. Later on, I was
talking about a particular item in the screen and added in parentheses
(#2 in Figure 4), this is acceptable.
What would be difficult on the reader, is looking at the picture with
numbers, there is no legend, and a page or so later to read:
In figure 2, note that 1 marks the entry area, 2 marks the command
buttons, 3 indicates the menu bar.... (or whatever).
I believe if you keep user accessibility foremost in your mind, you
can't go far wrong.
Nancy Allison wrote:
> Two questions about writing for translation:
> 1. I once knew of a PDF prepared by, I dunno, a translation company maybe, that was all about how to write with translation in mind. It was book-length and was highly recommended (at an STC meeting, Boston chapter, a few years ago). Does anyone know of it, and, if so, can you send me a link to it, assuming it is still available?
> 2. Specific, immediate concern: Callouts in figures. My client still has callouts (in Framemaker text boxes, if it matters) in the figure itself. What is the preferred format of callouts for translation? Put only numbers and arrows in the figure, and then have the key separate, in the main body text? Or have the key in a separate text frame, but within the anchored frame (that would be for Framemaker)?
> Free Software Documentation Project Web Cast: Covers developing Table of
> Contents, Context IDs, and Index, as well as Doc-To-Help
> 2009 tips, tricks, and best practices.
> Help & Manual 5: The complete help authoring tool for individual
> authors and teams. Professional power, intuitive interface. Write
> once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
> You are currently subscribed to TECHWR-L as dvora -at- tech-challenged -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/dvora%40tech-challenged.com
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
> Please move off-topic discussions to the Chat list, at:
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-