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.
The release numbers. Ah yes. We had a bit of fiddling with that one!
There was a Fixed version field in Jira, and at first I tried to use that. Hopeless. It is needed for whatever it is needed for and I could not use it for what I wanted it to do. So we added a custom Jira field called .. apologies writers for the terrible name ... Release Note Version Number.
What you describe sounds good, what we did a little bit different so for what it worth...
We don't add bugs to known issues and resolved issues. We have 'bug' as a type of issue. Also 'change request'. Also we don't have 'known issues' - the set of issues I am looking at are further down the pipeline than 'known' - they have been approved, groomed to sprint-readiness and put into sprint. Resolved is a stage in our sprint workflow and an issue gets to 'Resolved' after 'Documentation' is done.
I do a few different searches to cross check release notes data, but rely mainly on three fields for knowing I have got everything ready - include in release notes - starts sprint life as 'none' and gets set to 'yes' or 'no' when coding done, release note version number is blank at the beginning and is set to the version number we are releasing in style review, and release note title (only because it is/must be readable - more so than the summary of an issue it is given at beginning)
Cheers, Diana
-----Original Message-----
From: robert -dot- lauriston -at- gmail -dot- com [mailto:robert -dot- lauriston -at- gmail -dot- com] On Behalf Of Robert Lauriston
Sent: Friday, 10 January 2014 3:11 p.m.
To: Diana Corrigan; TECHWR-L Writing
Subject: Re: JIRA release notes & other doc features?
Yeah, I was thinking that custom fields could be useful. Maybe track the release numbers where I add a bug to the known issues and the resolved issues. Then I could fairly easily search for bugs that belong on my list of resolved issues for an upcoming issue: "known issue release"=not blank + status=resolved/closed + "resolved issue release"=blank, something like that.
On Thu, Jan 9, 2014 at 5:55 PM, Diana Corrigan <Diana -dot- Corrigan -at- visionsoftware -dot- com> wrote:
> We have been using Jira about six months.
>
> We record our release note information on Jira issue records - we've added fields to the issue record specifically for this purpose.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
