How do I associate documentation to a work item?
Some work items are "special" in that they deliver functionality that needs to be documented or noted in the release notes. At the time that the documentation or release notes are being prepared, one needs to be able to find all such work items and extract the relevant information from them to create the documentation or release notes.
Is there a standard way of doing this in Jazz? |
5 answers
I am not sure if I completely understand your question. However you may
want to consider adding keywords to the workitems so that you can query on them later. |
Hi Peter
Have a look at the Generate Build Notes action available from the context menu of a work item query. This action collects all build notes added to a work item and produces some sort of build notes. HTH, Tobias |
zrltkw wrote:
Have a look at the Generate Build Notes action available from the What does that command actually do? Where does it put the results? I ran that command on one of my queries and didn't notice it having any effect. And I can't find any documentation of the command. |
Hi Dave,
The "Generate Build Notes" action creates an HTML file in your temp directory with the text of the build notes found for the query. In order to see any results, the query must find at least one work item that has build notes. To create build notes for a work item, open the work item in the Work Item Editor. Click the "Add Build Notes" button on the main Team Concert toolbar. By default, it is the last button on the right. In M3 it has an icon similar to that of the New Work Item button. Clicking the button will create a "Custom" tab in the Work Item Editor. (You may need to close and re-open the editor to see the tab. I saw that problem in M3, but not in M4). Enter the text of your build note on the Custom Tab. When you run the "Generate Build Notes" action on a query that finds the work item you just modified, you will see a new editor open with the HTML file that was created. |
This is important, not just for release notes, but for any work item that has documentation impact. A small UI change could make dozens of help topics or tutorials or videos suddenly inaccurate or wrong.
Possible solutions: 1. Subscribe your team's information developer 2. Create a child work item for the required doc changes, and assign it to doc team. 3. Use some tag. 4. Add information developer as an approver on work item. 5. Add some field to work item for "Doc impact". |
Your answer
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.