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.
We just put the word "Fixed:" in bold at the head of the description, and then describe the issue.Â For some issues it's not a fix, but an improvement.Â So we put "Improvement:" on those.Â We generate internal and external versions of the RNs...Â We definitely do NOT expose the bug numbers to customers, but if we have a customer issue we expose that number.Â
A pet peeve of mine is repeating a phrase over and over.Â "This is not fixed..."Â Yeech!Â If I could just use an icon instead of the word "Fixed", I would.Â At first I just put issues in the "Fixed" section and left it at that. Some people in the field asked for more, so now we give the prefix in bold.Â But as little as possible is my guideline for this sort of thing.
BTW, we use DITA, and track issues in Jira.Â We generate XML from the Jira query and transform that to DITA.Â The bug description holds markup, including notes, tables, or whatever...Â Actually producing the final output is very swift, which is neat.Â The time and effort are all centered on actually researching the issue and giving the right information.Â If anybody is interested in doing something similar, feel free to ask for more details...
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"?
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com