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: When to use screenshots From:peter -at- softwell -dot- co -dot- uk To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 16 Feb 2005 10:34:04 +0000
>I'm wondering if any of you out there use explicit guidelines for when
>writers should use screenshots.
I'm a strong believer in minimal screenshots, BUT make sure the title of the DLL is clear and explicit and quoted exactly in the
text. Wherever possible, the description of the screen's fields should be in the help, not the documentation.
>At the company where I work as an editor, we're getting pressure from the
>localization department to drastically cut down on the number of
>screenshots in our guides. They localize into eight languages and spend
>way too much time, hence money, on recreating screenshots in the different
>languages.
Is the application localized? If so, then there should be no need to do anything other than just re-capture the screenshot.
If it's not, then why change them?
>On the one hand, we've identified the need to use common fictitious data
>in the processes we're making screenshots of (user names, file names,
>etc.), shared with localization, so localization can quickly set up their
>screens.
A good idea, but can't you set up a test implementation of the product with the names inserted?
>On the other, in my editing I'm seeing that lots of writers are throwing
>in screenshots when there really isn't any need for them. I'm now quite
>ruthless about tossing out screenshots.
Agreed, many new or poor writers will insert screenshots just to bulk out the documentation.
>My own off-the-top-of-my-head rule of thumb is that to be considered
>necessary, a screenshot has to help users get information quickly that
>they won't get just as fast by simply looking at the screen (assuming they
>are actually using the product as they read the doc). This seems to be:
As I've already said - use the help system. Also work with the developers to ensure that the screens present meaningful
names for the fields to be filled in or for the the action buttons.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.