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: Address this. . . From:Lisa Wright <lisawright -at- mail -dot- utexas -dot- edu> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 12 Mar 2010 10:55:53 -0600
I agree with Bill on this. Give customers a different way to find out
the status of requests/issues that haven't been included in the current
release, and focus the release notes on what IS included.
Lisa
On 3/12/2010 9:13 AM, Bill Swallow wrote:
> Ah, interpretation... I'm not going to answer your question. Instead
> I'll just offer advice:
>
> Don't include unresolved bugs in the release notes.
>
> does your company have an online bug base? Do customers have the
> ability to log in and see the status of their reported bugs? If not,
> look into it. If so, your work is done (with regard to unresolved
> bugs).
>
> IMHO, release notes should focus on what IS in the release and not on
> what isn't.
>
> I'd personally not like to look at the ingredients list on a box of
> Froot Loops to see "Non-Ingredients: real fruit, ground beef, lamb's
> tongue, lard, wood chips, roofing tar..."
>
> ;-)
>
> On Fri, Mar 12, 2010 at 9:55 AM, McLauchlan, Kevin
> <Kevin -dot- McLauchlan -at- safenet-inc -dot- com> wrote:
>
>> In the list of issues/bugs that are not being fixed for the current
>> release, we say "To be addressed in a future release".
>>
>> Some customer has decided that "To be addressed in a future release"
>> means "...an explicit prmise that the issue is to be fixed exactly how I want it".
>>
>> Please tell me what you believe is meant by "to address something".
>>
>
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-