Re: Software Release Notes

Subject: Re: Software Release Notes
From: Oquance <serdar -dot- a -dot- ozmen -at- gmail -dot- com>
To: Emoto <emoto1 -at- gmail -dot- com>
Date: Mon, 10 Jun 2019 21:04:41 +0300

I am using a phrase beginning with "Fixed an issue where ...".

On Mon, Jun 10, 2019, 9:02 PM Emoto <emoto1 -at- gmail -dot- com> wrote:

> Of course, every company has their own choice of what they put. I
> spent a long time documenting banking infrastructure software, and
> would routinely have to include language about a particular bug,
> whether it was in release notes or on a web site. I tended to use
> wording like "an issue was corrected where a missing 'abc_file' could
> allow approval of a payment without the required 'xyz' field being
> filled." I would try to use language to make the bug description as
> narrow as factually possible, so that the reader could correctly
> understand the (generally) limited scope and not worry about whether
> it happened in their installation or not.
>
> Bob
>
> On Mon, Jun 10, 2019 at 1:48 PM Lucy Draughn <ldraughn7 -at- gmail -dot- com> wrote:
> >
> > Hi there,
> >
> > I have a question about resolved issues in RNs - is it correct to use the
> > following text in the Resolved Issues of a software release:
> >
> > bug issue [bug number] *This is now fixed.*
> >
> > Is it appropriate to use "This is now fixed" in the resolved section? My
> > take is that the issue is in the Resolved sections so I would
> automatically
> > know that the issue is fixed so why use "This is now fixed"?
> >
> > Thanks,
> > Lucy
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > Visit TechWhirl for the latest on content technology, content strategy
> and content development | https://techwhirl.com
> >
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > You are currently subscribed to TECHWR-L as emoto1 -at- gmail -dot- com -dot-
> >
> > To unsubscribe send a blank email to
> > techwr-l-leave -at- lists -dot- techwr-l -dot- com
> >
> >
> > Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> > http://www.techwhirl.com/email-discussion-groups/ for more resources
> and info.
> >
> > Looking for articles on Technical Communications? Head over to our
> online magazine at http://techwhirl.com
> >
> > Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | https://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as serdar -dot- a -dot- ozmen -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Software Release Notes: From: Lucy Draughn
Re: Software Release Notes: From: Emoto

Previous by Author: RE: [External] Re: Software Release Notes
Next by Author: Re: Rule needed: expressing temperatures in two units of measurement in text
Previous by Thread: Re: [External] Re: Software Release Notes
Next by Thread: RE: Software Release Notes


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


Sponsored Ads