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.
I was talking about documenting something unnecessarily. For example,
there's no point in saying something like:
1. To delete a file, click the File menu and select Delete.
Previously, you needed to click the Options menu and select Delete.
The user didn't need to know this second bit of information to complete the
procedure, and if anything, this would just add confusion.
Obviously, procedures need to be explained so that users know what they're
doing, whether you're telling them to do something new or not. I meant that
it's not very useful to document old steps that are no longer applicable,
unless you're writing a changes doc or something similar.
Cheers,
Lisa
-----Original Message-----
From: Christine Gonzales [mailto:christine -dot- Gonzales -at- medstat -dot- com]
Sent: 06 July 2001 12:21
To: 'Lisa MacDonald'; TECHWR-L
Subject: RE: Old Functionality
<If you're writing a task-based
procedures document, I think that mentioning old functionality would
add a
lot of clutter. Steps should be short, simple, and to the point. >
What if the old procedures were never documented? What if the users just had
to use it. And, they don't know why they have to go to one item on the menu
for one function, they just do it. etc.
I am in a similar boat. I am coming in at the second or third release and
there is no previous documentation, or if there is -it is very minimal.
As new people come into the company should they have to learn the "old"
procedures like the others, then use the doc for the "new"?
Thanks,
Christine
--
NOTICE: The information contained in this electronic mail transmission is
intended by Convergys Corporation for the use of the named individual or
entity to which it is directed and may contain information that is
privileged or otherwise confidential. If you have received this electronic
mail transmission in error, please delete it from your system without
copying or forwarding it, and notify the sender of the error by reply email
or by telephone (collect), so that the sender's address records can be
corrected.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
