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: 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-