Re: JIRA release notes & other doc features?

Subject: Re: JIRA release notes & other doc features?
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 2 Jan 2014 10:45:30 -0500

The JIRA release notes feature literally only spits out what is in the JIRA
ticket. In my case, that means totally cryptic and incomplete descriptions
like "null pointer" or "404 error" that would be pretty much useless for
distinguishing one bug fix from another (because we get a ton of similar
error messages, but with different base causes). Sometimes the developer
who enters the bug has already fixed it and is just creating a ticket for
time tracking purposes and doesn't bother to record many details other than
a bug existed and they fixed it.

I've never worked anywhere that published their entire list of fixed issues
(since QA finds most of our bugs). So unless you either train everyone who
uses your system to write customer ready ticket descriptions or plan to go
in and clean up every single ticket by hand, it's pretty much useless.
I've seen it used in production (one of our development partners publishes
their Release Notes straight from JIRA) and I was appalled at how much of
their "dirty laundry" they were willing to hang out in public. I prefer to
manage what new features and bugs get reported in Release Notes rather than
just dump a couple hundred raw JIRAs for customers to have to wade through
to see if their bug got fixed.




On Wed, Jan 1, 2014 at 3:21 PM, Robert Lauriston <robert -at- lauriston -dot- com>wrote:

> Any hands-on reports about the JIRA release notes tool or other
> doc-oriented features?
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as jstickler -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
>



--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


References:
JIRA release notes & other doc features?: From: Robert Lauriston

Previous by Author: RE: geo-fence or geofence or geo fence?
Next by Author: Re: app vs. application
Previous by Thread: JIRA release notes & other doc features?
Next by Thread: RE: JIRA release notes & other doc features?


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


Sponsored Ads