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:"Butler, Darren J CTR USAF AFMC 584 CBSS/GBHAC" <Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil> To:"Rebecca Hopkins" <rebecca_hopkins -at- comcast -dot- net> Date:Tue, 8 Jul 2008 16:37:37 -0400
>>>It's just as you have illustrated...
1. Typical Data Flow
<diagram>
1.1 About the Data Flow Diagram<<<<
Well, I would consider the title of your section as "leading" the
section and not the graphic- and yes, I know that sounds simplistic.
As a rule, the only time I have a graphic lead-off a section is for my
Illustrated Parts Lists; it doesn't make sense to put the list of parts
before the picture.
I also think that in cases where you have several variations of the same
item (such as differing models or configurations), showing a graphic as
early in the section as possible would help the reader ensure he is in
the correct section. Making him read through two paragraphs of text
before he realizes that the info doesn't apply to the part that he
holding in his hand, isn't user-friendly.
My $0.02,
DJ
-----Original Message-----
From:
techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot-
com] On Behalf Of Rebecca Hopkins
Sent: Tuesday, July 08, 2008 2:29 PM
To: Tech Whirlers
Subject: RE: Never lead with a graphic
DJ,
It's just as you have illustrated...
1. Typical Data Flow
<diagram>
1.1 About the Data Flow Diagram
<text>
-----
Rebecca
-------------- Original message ----------------------
From: "Butler, Darren J CTR USAF AFMC 584 CBSS/GBHAC"
<Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil>
> Can we also assume that your section has some sort of title that
orients
> the reader to subject that the graphic addresses?
> Ex.
> SECTION VI -- Sludge Pumps
>
> <photo of a sludge Pump>
> <text>
>
>
> DJ
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats
or
printed documentation. Features include support for Windows Vista & 2007
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
Darren -dot- Butler -dot- ctr -at- robins -dot- af -dot- mil -dot-
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-