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:"Meryl R. Cohen" <merylster -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com, Praneeta Paradkar <praneeta_paradkar -at- yahoo -dot- com> Date:Mon, 22 Feb 2010 09:49:01 -0500
Future tense! Then you can resolve issues you haven't even fixed yet, much
more productive.
More seriously, my choice would be number 3 with the addition of what does
happen if that is not very obvious from just stating the resolution.
--Meryl
On Mon, Feb 22, 2010 at 5: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
>
>
> Your Mail works best with the New Yahoo Optimized IE8. Get it NOW!
>http://downloads.yahoo.com/in/internetexplorer/
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 merylster -at- gmail -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/merylster%40gmail.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
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
