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:"Rebecca Hopkins" <rebecca_hopkins -at- comcast -dot- net>, "Tech Whirlers" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 8 Jul 2008 11:57:30 -0700
I assume that my reader is using one of my applications and has come to
the user docs because he doesn't understand something or is otherwise
having problems. In other words, as he is reading my docs, he has the
GUI open on his monitor. Granted that, while I usually do have
introductory text, I ensure the graphic appears on the first screen of
the help (or page in a PDF) for the given section. This quickly lets the
reader know, "you are here". Explanatory text always comes after this.
I can't imagine any reason why you wouldn't want a screenshot on the
first page of a help section. Why not ask your boss his rationale? Or,
maybe you can tell him that you don't understand and ask him to provide
some samples.
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 Rebecca Hopkins
Sent: Tuesday, July 08, 2008 11:14 AM
To: Tech Whirlers
Subject: RE: Never lead with a graphic
Leonard,
Yes, the graphic is preceded by a heading, as is the explanatory text.
-----
Rebecca
-------------- Original message ----------------------
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
> Can we assume that the graphic has a header or some other type of
> identifier that lets the reader know what he's looking at?
>
> 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 Rebecca Hopkins
> Sent: Tuesday, July 08, 2008 11:07 AM
> To: Tech Whirlers
> Subject: Never lead with a graphic
>
> Folks,
>
> My new boss tells me that I should never begin a section with a
graphic;
> the explanation of the graphic must precede the graphic.
>
> This makes no sense to me....
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-