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: screen dumps in books From:Betsy Maaks <bmaaks -at- TELLABS -dot- COM> Date:Wed, 20 Jan 1999 09:20:34 -0600
Sean,
In general, manuals are written for people who don't
know how to use the software. They don't know what
to expect, what is normal behavior and what is not
normal behavior. Traditionally, screen shots (or
representations by typing and using a rounded box)
are used in documentation so the user can confirm
that what he/she sees displayed on the screen is
correct, thereby confirming that he/she is using
the correct procedure. This builds the user's
confidence in performing the task on the computer.
It's your basic human/computer interaction.
You the writer can make judgments about the
content of the computer responses based on
your knowledge of the "typical" software user of
the product you're writing for. A general rule
is to reinforce the positive behavior (what is
supposed to happen) and mention the pitfalls
with methods for avoiding them or referring
them to troubleshooting procedures.
FWIW,
Betsy Maaks
reply to: bmaaks -at- tellabs -dot- com
