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:Use of Addendum or other suggestion? From:"Cindy Parker" <cparker -at- fuse -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 5 Jun 2001 12:06:48 -0400
Folks,
<short background>
After creating and releasing an installation CD-ROM, we found a major bug.
(imagine that). A particular web page appears for our Macintosh users but
the code was incorrect and only displays the raw html code, but does not go
the necessary web page. We know why this occurred and it has been corrected
for the next release.
I wrote the installation guide that accompanies the CD-ROM. The directions
in the guide take the end-user step-by-step through this process. Because
of the problem above, all Mac installations stop in their tracks. My
solution is to print a one page addendum instructing our users to basically
do the following:
Launch their browser and enter the blahblahblah url in the address field.
(of course I'll write better instructions than this...)
</short background>
This solution is simple and inexpensive. My question is this...
How would you title the addendum? I wanted to use "ADDENDUM for MAC 8.6 and
9.0 Users" or something along those lines. But the problem is, our customer
base is the general public... I don't know if they would understand the term
addendum.
Has anyone else released a one page document such as this for the general
public and how have you titled it? This is a first for me (since we tend to
not make proactive corrections) for use with the general public. Addendum
has worked in the past with Techie manuals I've written.
Thanks in advance. I appreciate any and all ideas.
Regards,
C.
Cindy Parker
Information Engineer, Online Architecture
ZoomTown.com
*** 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
Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.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.
