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:"Keith Hansen" <KRH -at- weiland-wfg -dot- com> To:"Tech Whirlers" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 8 Jul 2008 16:09:05 -0500
I agree with John here.
Let's say I have a heading that says "Adding Accounts Using the Wizard."
Next, without any explanation, I just show the wizard. As a reader, I
* What is a wizard?
* Where is the wizard located?
* When should I use the wizard?
* Why should I use the wizard?
* How do I use the wizard?
It would be like showing film footage on a newscast accompanied with
total silence (no newscaster providing background or context).
As for the bus map analogy:
* What if I don't know it's a bus map?
* What if I wasn't even aware that a bus line exists in my town?
* Introductory information (context and background)
* Map (big picture)
* Complete schedule (Details)
From: techwr-l-bounces+krh=weiland-wfg -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+krh=weiland-wfg -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Rebecca Hopkins
Sent: Tuesday, July 08, 2008 3:34 PM
To: Tech Whirlers
Subject: Re: Never lead with a graphic
The graphic represents the functionality at a very basic level - the big
-------------- Original message ----------------------
From: "John Posada" <jposada99 -at- gmail -dot- com>
> Rebecca...the graphic ISN'T the most important thing and it's not the
> thing you want the user to see.
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-