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:"Barb Einarsen" <barb -dot- einarsen -at- navtelcom -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 16 Feb 2005 10:56:54 -0500
Pro-screen shot example:
We have JavaHelp for some of our newer products. This help works as
online documentation rather than 'help' as it is not context sensitive
(you can only access the first topic no matter where you click help).
Another writer felt that screen shots were unnecessary as it is a help
file. I felt that screen shots were necessary as the user is not
necessarily on the screen that they require and a visual aid that they
are on the appropriate screen would be helpful.
While I was updating the files, including adding screen shots, a tester
placed a bug report against the documentation because the documented
fields did not match the fields he saw on screen. There was no bug ~ HE
WAS ON THE WRONG SCREEN.
Morale of the story; it is that easy to go from correct to incorrect in
the mind of your user.
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.