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.
In general, I reckon the amount of screenshots you include correlates
inversely with your audiences' knowledge of what they're installing.
The more knowledgeable they are, the less screenshots you include. And vice
versa.
If there's likely to be some ambiguity, I'll include a screenshot.
That quote from somebody or other springs to mind now, "To say something is
foolproof is to underestimate a fool."
Regards,
Kieran.
________________________________________
Kieran Sullivan
Telecommunications Software & Systems Group, (www.tssg.org)
Waterford Institute of Technology, (www.wit.ie)
Blog: http://pureprose.wordpress.com/
-----Original Message-----
From: techwr-l-bounces+ksullivan=tssg -dot- org -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+ksullivan=tssg -dot- org -at- lists -dot- techwr-l -dot- com] On Behalf Of
Kat Kuvinka
Sent: 02 September 2010 17:01
To: isaunders -at- syntellect -dot- com; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Use of screenshots in procedures?
My thinking was along the same line as yours, until I documented an
Installshield Wizard that required user input on almost every screen. It was
so complicated that Support usually had to walk the customers through the
process. So we used a screen shot for each step.
> Subject: Use of screenshots in procedures?
>
> Hi,
>
> I have to update some software installation procedures, each of which
contains about a dozen screengrabs of the InstallShield wizard at various
stages during the process. Are all these graphics really necessary?
Personally, I think they are way over the top, and turn what would be one
page of instructions into six pages that simply mimic what you will be
seeing on the screen as you perform the task.
>
> Before I start screaming and stamping my feet, however, I thought I would
find out what the current thinking is on this question.
>
> To illustrate (the obvious) or not? That is the question!
>
> TIA
>
> Ian Saunders
> Syntellect
> UK
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Gain access to everything you need to create and publish information
> through multiple channels. Your choice of authoring (and import)
> formats with virtually any output. Try Doc-To-Help free for 30-days.
>http://www.doctohelp.com/
>
> LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
> Use referral code TECHWR-L for $50 off conference tuition!
> See program at: http://lavacon.org/
>
>
> ---
> You are currently subscribed to TECHWR-L as katkuvinka -at- hotmail -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/katkuvinka%40hotmail.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:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. http://www.doctohelp.com/
LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at: http://lavacon.org/
---
You are currently subscribed to TECHWR-L as ksullivan -at- tssg -dot- org -dot-
No virus found in this incoming message.
Checked by AVG - www.avg.com
Version: 9.0.851 / Virus Database: 271.1.1/3107 - Release Date: 09/01/10
19:34:00
Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. http://www.doctohelp.com/
LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at: http://lavacon.org/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
