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: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 22 Feb 2010 06:55:26 -0800

Release notes often contain a variety of information. New features and
known issues generally work best be in present tense. I prefer to
write bug fixes as per your #3 though sometimes present perfect works
better.

On Mon, Feb 22, 2010 at 2:13 AM, Praneeta Paradkar
<praneeta_paradkar -at- yahoo -dot- com> wrote:
> Hi,
>
> 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?
>
> Thanks,
>
> Praneeta
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Previous by Author: Re: Naming a department
Next by Author: ergonomics & injuries (was: Re: Chin up, you)
Previous by Thread: Re: Should the resolved issues section in Release Notes be in the past tense or the present?
Next by Thread: Re: Should the resolved issues section in Release Notes be in the past tense or the present?


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


Sponsored Ads