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.
Re: Software button removed after documentation is sent to printe r
Subject:Re: Software button removed after documentation is sent to printe r From:"Gottlieb, Lynn" <Lynn -dot- Gottlieb -at- PSS -dot- BOEING -dot- COM> Date:Tue, 28 Apr 1998 08:38:46 -0700
When I ship my product, I always include both an electronic and paper
"Read Me" document. Our clients understand that the paper documentation
is often in the printer's hands before the software is frozen solid.
They know the "Read Me" includes last minute information as well as
installation instructions and warnings.
So if I were you, I would print a page containing the button information
and arrange to have the page placed in the documentation packet so that
it would not be missed. I might write my notes so that they could be
inserted into the documentation (perhaps in the section where the button
in addressed) so that folks would see the added information when they
read the button documentation).
After all that's done, I would attend the release's post mortem (or
"lessons learned" meeting). I would talk to the R&D folks about what
can be done to prevent this kind of problem from happening again.
> From: Suzanne Gerrior[SMTP:suzanne -at- JAZZMAIL -dot- COM]
> Reply To: Suzanne Gerrior
> Sent: Tuesday, April 28, 1998 8:16 AM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Re: Software button removed after documentation is sent
> to printer
> I would like to know what people would do in this situation.
> Your documentation is ready, postscript file prepared, sent to the
> he's in the process of printing x number of copies. You find out that
> has neglected to inform you that a button (fairly significant button)
> been removed from the interface at the last minute.
> Do you recall the documentation from the printer - that's NOT going to
> Do you print a page saying that the button mentioned on page ?? is no
> available and include the page with the document (the document is
> going to
> be shrink wrapped).
> Do you go on vacation and hope that it all goes away? (My personal
> Suzanne Gerrior
> Documentation Specialist
> Jazz Media Network
> Tel: (514) 931-7009, ext. 255
> Fax: (514) 931-9495
> suzanne -at- jazzmail -dot- com
> >Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
> >Check out topic summaries at
> Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
> Check out topic summaries at