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.
I also use the phrase "Fixed an issue where...." as well as "Fixed an issue that arose when...."
-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Oquance
Sent: Monday, June 10, 2019 2:05 PM
To: Emoto <emoto1 -at- gmail -dot- com>
Cc: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: Re: Software Release Notes
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
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
Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com
