Re: Should the resolved issues section in Release Notes be in the past tense or the present?

Subject: Re: Should the resolved issues section in Release Notes be in the past tense or the present?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 22 Feb 2010 22:16:04 -0800

At the company that still holds my award for the best development-marketing
relationship I've ever seen, we wrote release notes to refer to new features and
improvements in present tense and resolved issues/eliminated bugs in past tense,
to help reinforce the notion in the customer's mind that the issues/bugs
were...past.

Gene Kim-Eng


----- Original Message -----
On Mon, Feb 22, 2010 at 3:43 PM, Praneeta Paradkar <
praneeta_paradkar -at- yahoo -dot- com> wrote:
>
> This is a long raging debate in my team about the tense used for resolved
> issues in the Release Notes document.
>
> I have seen various release notes documents, and my observations are as
> follows:
>
> 1. Present tense is used.
> 2. Past tense is used.
> 3. Present tense is used and the issue is stated in "resolution" form. For
> example, running the ABC script no longer gives the XYZ error.
>
> What is the best way to move forward?

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Should the resolved issues section in Release Notes be in the past tense or the present?: From: Praneeta Paradkar
Re: Should the resolved issues section in Release Notes be in the past tense or the present?: From: punit shrivastava

Previous by Author: RE: Chin up, you
Next by Author: RE: There must be some kind of standard....
Previous by Thread: Re: Should the resolved issues section in Release Notes be in the past tense or the present?
Next by Thread: Chin up, you


What this post helpful? Share it with friends and colleagues:


Sponsored Ads