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: Never lead with a graphic From:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:<mhbethel -at- rmbeditorial -dot- com>, "Rebecca Hopkins" <rebecca_hopkins -at- comcast -dot- net>, "Tech Whirlers" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 8 Jul 2008 14:47:33 -0700
A lot seems to hinge on "first text reference". The "first text
reference" can easily be a title. Is the phrase defined in Chicago?
Having said that, I think the structure Keith suggests is best:
1. Introduction (perhaps only a sentence in some cases--maybe even just
the title: "Route 1 - Metropolitan Transit System").
2. Graphic
3. Details and "How to"
Leonard
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Marci Bethel, RMB Editorial Services
Sent: Tuesday, July 08, 2008 1:25 PM
To: 'Rebecca Hopkins'; 'Tech Whirlers'
Subject: RE: Never lead with a graphic
Rebecca, I have to agree with your boss. Chicago (15th ed)
12.10 also recommends placing text before graphics:
12.10 Placement
In a printed work, an illustration should appear as soon as
possible after the first text reference to it.... It may
precede the reference only if it appears on the same page or
same two-page spread as the reference or if the text is too
short to permit placing all figures and tables after their
references. ...
Best,
Marci
-----Original Message-----
From:
techwr-l-bounces+mhbethel=rmbeditorial -dot- com -at- lists -dot- techwr-l -dot- co
m
[mailto:techwr-l-bounces+mhbethel=rmbeditorial -dot- com -at- lists -dot- tec
hwr-l.com] On Behalf Of Rebecca Hopkins
Sent: Tuesday, July 08, 2008 12:44 PM
To: Tech Whirlers
Subject: RE: Never lead with a graphic
Leonard,
Thanks for the advice - I'm just arming myself for the
inevitable conversation with the boss.
I talked to one of my younger co-workers, and he said that's
what he learned in school as well - never lead with a
graphic. He could not remember the rationale, however. Since
the boss is newer to the tech writing circus than I am, I'm
thinking she also "received" this wisdom that I missed out
on.
We're going through one of those clean-out-the-fridge,
salute-it-or-paint-it re-orgs of the company's various doc
sets, and standards for standardization's sake are being
carved in stone as we speak. Two people who remember it from
class outnumber one person's personal opinion. I will have
to find references to back up my argument.
-----
Rebecca
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-