The process of managing entries assumes that you document known issues in the work items. To do this correctly, please read the documentation under the "Release Note Tab Extension" tab.
Step-by-Step Guide
- Creation of a Known Issue: Capture the known issue as a work item and provide all relevant information in the Release Note Tab extension.
- Defining the Query: When creating the entry, define a query that specifically searches for work items containing known issues. This query is executed every time the entry is retrieved.
- Automatic Update: The query ensures that the work items are automatically reconciled to determine if a known issue exists for them. This eliminates the need for a manual import process, as the items always remain up-to-date.
Advantages
- Continuous Update: The work items are updated in real-time, so the current status of the known issues is always displayed.
- Efficiency: The automated process saves time and reduces errors that could arise from manual updates.
- Transparency: Through central management and automatic updating, all team members always have access to the latest information.
Example
Imagine your team regularly creates bugs as known issues. Your defined query in the entry only lists bugs that have a status that is, for example, not "Done".
- Open Bugs: As long as a bug is not completed, it remains in the list of known issues. When new bugs are captured, they are automatically added to the list.
- Completed Bugs: Once a bug is completed by the team, its status changes. This bug will then no longer be displayed in the list of known issues when the query is next retrieved and thus disappears from the entry.
This process ensures that your release notes are always up-to-date and only list the relevant, yet unresolved issues. As soon as a bug is completed, it is documented in the release notes, ensuring a seamless and automated workflow.