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:Screen shots for online help From:"G. Abenhaim" <g -dot- abenhaim -at- nhc -dot- com> To:<cgilbert -at- cal -dot- berkeley -dot- edu> Date:Mon, 18 Aug 2003 14:32:58 -0400
-----Original Message-----
From: G. Abenhaim [mailto:g -dot- abenhaim -at- nhc -dot- com]
Sent: Monday, August 18, 2003 2:31 PM
To: Carol Gilbert [cgilbert -at- cal -dot- berkeley -dot- edu]
Cc: TECHWR-L
Subject:
On Monday, August 18, 2003, at 02:24 AM, Anitha R wrote:
> How many of you include screenshots in your Online Help files?
We ALWAYS use screenshots for online help to let users know what they are
supposed to see on screen. If they do not get the extact screen when they
use teh software, then they know they have missed a step. I would say every
page has at least one or two screen shots..the documentation here at my
company must be very detailed. Any less, we would get calls from our clients
complaining.
Screenshots and their description help the users understand more easily.
remember, that you always need to write your documents as "dummy proof"; as
if they never had background knowledge..so even the high level technician
can understand the low level of the application.
