Skip to content

Commit eafb24e

Browse files
authored
Merge pull request #3854 from john-par/1867274-improve-seo-report-articles-10-14
1867274, updated /report/sql-reports/ articles for SEO and Acrolinx improvement (Part 1)
2 parents 665a446 + db20d78 commit eafb24e

12 files changed

+339
-324
lines changed

docs/report/sql-reports/address-inaccuracies-published-for-summary-values.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Address inaccuracies published for summary values
3-
titleSuffix: Azure DevOps Server
3+
titleSuffix: Azure DevOps
4+
description: Learn how to correct reports with hours that are counted twice.
45
ms.technology: devops-analytics
56
ms.topic: troubleshooting
6-
description: Corrects the reports with hours that are counted twice with this procedure.
77
ms.assetid: 09e8e02d-9ecb-4012-9ee0-cebb89372096
88
ms.author: kaelli
9-
ms.date: 10/31/2017
9+
ms.date: 10/14/2021
1010
---
1111

1212

@@ -19,13 +19,13 @@ If you see that hours are counted twice in reports that contain task hours, you
1919
> [!NOTE]
2020
> When you use Office Project to create parent and child tasks, it assigns parent tasks the rollup of hours that are defined for all its child tasks. Rollup hours are not published to Team Foundation so that the hours are not double-counted in certain reports. The Microsoft Project mapping file attribute, **IfSummaryRefreshOnly**, suppresses the publication to Team Foundation of the hours that are assigned to summary tasks. You can view the rollup of hours for summary tasks in Office Project but not in Team Foundation. For more information, see [Customize the Microsoft Project field mapping file](/previous-versions/azure/devops/reference/xml/map-microsoft-project-fields-to-tf-fields).
2121
22-
When both summary tasks and their child tasks contain hours in the effort fields, you essentially have double-counting of the level of task effort. To address these inaccuracies, you must clear the **Original Estimate** (or **Baseline Work** for team projects that have been upgraded), **Remaining Work**, and **Completed Work** fields for the summary or parent tasks.
22+
When both summary tasks and their child tasks contain hours in the effort fields, you essentially have a double-counting of the level of effort a task requires. To address these inaccuracies, you must clear the **Original Estimate** (or **Baseline Work** for team projects that have been upgraded), **Remaining Work**, and **Completed Work** fields for the summary or parent tasks.
2323

2424
**Required Permissions**
2525

26-
To perform this procedure, you must be a member of the **Contributors** group or your **View work items in this node** and **Edit work items in this node** permissions must be set to **Allow**. For more information, see [Permission reference](../../organizations/security/set-project-collection-level-permissions.md).
26+
To carry out this procedure, you must be a member of the **Contributors** group or your **View work items in this node** and **Edit work items in this node** permissions must be set to **Allow**. For more information, see [Permission reference](../../organizations/security/set-project-collection-level-permissions.md).
2727

28-
### To clear the hour fields of parent or summary tasks
28+
## Clear the hour fields of parent or summary tasks
2929

3030
1. In Team Explorer, expand the **Work Items** node for your team project, and locate the **Work Items with Summary Values** team query.
3131

@@ -42,7 +42,7 @@ If you see that hours are counted twice in reports that contain task hours, you
4242
> [!IMPORTANT]
4343
> Export the query results to Office Excel with the rows collapsed. This condition exports only the parent or summary tasks.
4444
45-
6. In the Excel document, for the area and iteration paths that you are managing, clear the values in the following three columns:
45+
6. In the Excel document, for the area and iteration paths that you're managing, clear the values in the following three columns:
4646

4747
- **Original Estimate**
4848
- **Remaining Work**

docs/report/sql-reports/backlog-overview-scrum.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
22
title: Backlog overview (Scrum)
3-
titleSuffix: Azure DevOps Server
3+
titleSuffix: Azure DevOps
4+
description: Learn about the Backlog Overview report and how it returns the lists of all product backlog items.
45
ms.technology: devops-analytics
56
ms.topic: reference
6-
description: Reports the lists of all product backlog items (PBIs).
77
ms.assetid: b3e2c54e-99de-47d1-9fa5-08539ff31c87
88
ms.author: kaelli
9-
ms.date: 10/17/2017
9+
ms.date: 10/14/2021
1010
---
1111

12-
13-
1412
# Backlog overview (Scrum)
1513

1614
[!INCLUDE [temp](../includes/tfs-report-platform-version.md)]
@@ -25,11 +23,11 @@ The Backlog Overview report lists all product backlog items (PBIs), both active
2523

2624
|Work progress|Quality progress and risk assessment|
2725
|-------------------|------------------------------------------|
28-
|- How much work does each PBI require?<br />- Does the amount of work that remains for each PBI correspond to your expectations?<br />- Are top-ranked PBIs being implemented first?<br />- How many tests are defined for each PBI? How many tests are passing?<br />- Which PBIs don't have test cases?|- How many test cases have run for each PBI, and how many have passed?<br />- Which PBIs are at risk?<br />- Which PBIs are not stable enough for release?<br />- Which PBIs can the team ship today?|
26+
|- How much work does each PBI require?<br />- Does the amount of work that remains for each PBI correspond to your expectations?<br />- Are top-ranked PBIs being implemented first?<br />- How many tests are defined for each PBI? How many tests are passing?<br />- Which PBIs don't have test cases?|- How many test cases have run for each PBI, and how many have passed?<br />- Which PBIs are at risk?<br />- Which PBIs aren't stable enough for release?<br />- Which PBIs can the team ship today?|
2927

3028
**Requirements**
3129

32-
- This report requires that the team project collection that contains your team project was provisioned with SQL Server Reporting Services. This report is not available if ![Report](media/icon_reportte.png "Icon_reportTE") **Reports** does not appear when you open Team Explorer and expand your team project node.
30+
- This report requires that the team project collection that contains your team project was provisioned with SQL Server Reporting Services. This report isn't available if ![Report](media/icon_reportte.png "Icon_reportTE") **Reports** doesn't appear when you open Team Explorer and expand your team project node.
3331

3432
- To view the report, you must be assigned or belong to a group that has been assigned a **Browser** or **Content Manager** role in Reporting Services. For more information, see [Grant permissions to view or create reports in TFS](../admin/grant-permissions-to-reports.md).
3533

@@ -40,12 +38,12 @@ The Backlog Overview report lists all product backlog items (PBIs), both active
4038
|-------------------|-----------------|
4139
|- **Hours Breakdown**: A visual representation that shows the percentage of completed work based on the rollup of remaining hours for all tasks that are linked to the PBI or its child PBIs.<br />- **To Do**: A rollup of the remaining hours for tasks in the To Do state that are linked to the PBI or its child PBIs.<br />- **In Progress**: A rollup of the remaining hours for tasks in the In Progress state that are linked to the PBI or its child PBIs.|- **Test Points**: A numeric value that represents the number of pairings of test cases with test configurations in a specific test suite. For more information about test points, see [Reporting on testing progress for test plans](../../test/track-test-status.md).<br />- **Test Results**: A numeric value and visual representation that shows the percentage of test cases, grouped according to the status of their most recent test run, where the options are **Passed** (green), **Failed** (red), or **Not Run** (black).|
4240

43-
### <a name="Interpreting"></a> Healthy and unhealthy versions of the report
41+
## <a name="Interpreting"></a> Healthy and unhealthy versions of the report
4442
A healthy report shows more progress on PBIs that appear near the top of the report.
4543

4644
An unhealthy report indicates progress on PBIs that have a lower rank than on PBIs that have a higher rank, or that more tests are failing than passing.
4745

48-
### PBIs that appear in the report
46+
## PBIs that appear in the report
4947
The report lists and highlights PBIs according to the following criteria:
5048

5149
- PBIs appear in order of their importance, based on their assigned ranking (Backlog Priority field).
@@ -56,8 +54,8 @@ The Backlog Overview report lists all product backlog items (PBIs), both active
5654

5755
- PBIs appear in gray type when their assigned iteration or area is outside the filtered set, but they have tasks or child PBIs that are within the filtered set of iterations or product areas.
5856

59-
### Required activities to track the backlog
60-
To populate the report with useful data, the team performs the following activities:
57+
## Required activities to track the backlog
58+
To populate the report with useful data, the team carries out the following activities:
6159

6260
- Define PBIs and tasks. Make sure that tasks are linked to their parent PBIs through a **Child** link. Also, create a **Child** link from any subtasks to its parent task. For more information, see [Define the tasks required to implement PBIs and bugs](../../boards/work-items/guidance/scrum-process-workflow.md?viewFallbackFrom=vsts).
6361

docs/report/sql-reports/bug-status-report.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
2-
title: Bug Status Report
3-
titleSuffix: Azure DevOps Server
2+
title: Bug Status report
3+
titleSuffix: Azure DevOps
4+
description: Learn how to track the team's progress toward resolving and closing bugs by viewing the Bug Status report.
45
ms.technology: devops-analytics
56
ms.topic: reference
6-
description: Track the team's progress toward resolving and closing bugs by viewing the Bug Status report.
77
ms.assetid: ede30011-e04a-4914-ab68-b4c725a54f96
88
ms.author: kaelli
9-
ms.date: 10/17/2017
9+
ms.date: 10/14/2021
1010
---
1111

12-
13-
# Bug Status Report
12+
# Bug Status report
1413

1514
[!INCLUDE [temp](../includes/tfs-report-platform-version.md)]
1615

@@ -37,7 +36,7 @@ After the team has started to find and fix bugs, you can track the team's progre
3736
|Information|Description|
3837
|-----------------|-----------------|
3938
|**Number of Bugs**|A visual representation of the cumulative count of all bugs, grouped by their state.|
40-
|**Active Bugs by Priority/Severity**|A pie chart that depicts the number of bugs that are still active, grouped by priority or severity.|
39+
|**Active Bugs by Priority/Severity**|A pie chart that shows the number of bugs that are still active, grouped by priority or severity.|
4140
|**Active Bugs by Assignment**|A horizontal bar chart with the total count of bugs that each team member has assigned to them in the active state, grouped by priority or severity.|
4241
|**Resolved Bugs by Assignment**|A horizontal bar chart with the total count of bugs that each team member has assigned to them in the resolved state, grouped by priority or severity.|
4342

@@ -50,7 +49,7 @@ After the team has started to find and fix bugs, you can track the team's progre
5049
For more information, see [Filtering the Report and Changing the Display](#Changing) later in this article.
5150

5251
### Required Activities for Tracking Bugs
53-
For the Bug Status report to be useful and accurate, the team must perform the following activities:
52+
For the Bug Status report to be useful and correct, the team must carry out the following activities:
5453

5554
> [!NOTE]
5655
> The team can use the Triage Workbook to review, rank, prioritize, and assign bugs. For more information, see [Workbooks](/previous-versions/azure/devops/report/sharepoint-dashboards/workbooks) .
@@ -66,19 +65,19 @@ After the team has started to find and fix bugs, you can track the team's progre
6665

6766
- Update the state of each bug as it is fixed, verified, and closed.
6867

69-
## <a name="Duration"></a> Setting the Duration of the Iteration
70-
To understand the progress that the team is making for your current iteration, the start and end dates for the report must match those of your current iteration cycle.
68+
## <a name="Duration"></a> Set the Duration of the Iteration
69+
To understand the progress that the team is making for your current iteration, the start and end dates for the report must match the dates of your current iteration cycle.
7170

72-
#### To change the duration of the iteration
71+
### To change the duration of the iteration
7372

74-
1. Next to **Iteration Start (Date)** or **Iteration End (Date)**, click the calendar icon, and then click a date.
73+
1. Next to **Iteration Start (Date)** or **Iteration End (Date)**, select the calendar icon, and then select a date.
7574

76-
2. Click **View Report**.
75+
2. Select **View Report**.
7776

78-
## <a name="Interpreting"></a> Interpreting the Report
79-
You should expect the Bug Status report to vary based on where you are in your product development cycle. Early iterations should exhibit a gradual increase in the number of active bugs. Iterations that are near the end of a development cycle should exhibit a wide band of resolved bugs.
77+
## <a name="Interpreting"></a> Interpret the Report
78+
You can expect the Bug Status report to vary based on where you are in your product development cycle. Early iterations should show a gradual increase in the number of active bugs. Iterations that are near the end of a development cycle should show a wide band of resolved bugs.
8079

81-
### Questions That the Report Answers
80+
### Questions the report answers
8281
You can review the report to determine the progress within an iteration or over time. Specifically, you can find answers to the following questions:
8382

8483
- How quickly is the team resolving and closing bugs?
@@ -91,14 +90,15 @@ After the team has started to find and fix bugs, you can track the team's progre
9190

9291
- How many bugs are assigned to each team member?
9392

94-
- Does any team member need help to resolve or close bugs?
93+
- Does any team member need help with resolving or closing bugs?
9594

96-
### Healthy Version of Report
97-
A healthy Bug Status report shows an increase in active bugs over time followed by a steady progression of resolving and closing bugs, as the following illustration shows. When the team fixes more bugs than it finds, the number of active bugs decreases.
95+
### Healthy version of report
96+
97+
A healthy Bug Status report shows an increase in active bugs over time followed by a steady progression of resolving and closing bugs, as the following illustration shows. When the team fixes more bugs than it finds, the number of active bugs goes down.
9898

9999
![Healthy version of Bug Status Report](media/procguid_bugstatus_healthy.png "ProcGuid_BugStatus_Healthy")
100100

101-
### Unhealthy Version of Report
101+
### Unhealthy version of report
102102
The following illustration shows an unhealthy version of the Bug Status report.
103103

104104
![Unhealthy version of Bug Status Report](media/procguid_bugstatus_unhealthy.png "ProcGuid_BugStatus_Unhealthy")
@@ -108,12 +108,12 @@ After the team has started to find and fix bugs, you can track the team's progre
108108
|Indicator|Questions to ask|
109109
|---------------|----------------------|
110110
|**The band for active bugs is becoming wider**. If the width of the team's band for active bugs is increasing, the bug backlog is growing. The team is finding more bugs than it can resolve or close.<br /><br /> A widening active bug band might indicate that a bottleneck is slowing the team's ability to resolve and close bugs.|- Are team members being reallocated to other, non-priority tasks?<br />- Are other issues blocking the team's ability to resolve and fix bugs?|
111-
|**The number of active bugs is not changing**. A flat trend in the number of active bugs indicates that the team is not finding bugs.|- Is the test coverage sufficient?<br />- Are other issues blocking the team's ability to find bugs?|
111+
|**The number of active bugs is not changing**. A flat trend in the number of active bugs indicates that the team isn't finding bugs.|- Is the test coverage sufficient?<br />- Are other issues blocking the team's ability to find bugs?|
112112
|**The number of resolved or closed bugs is not changing**. When the number of bugs that are being resolved or closed remains flat for long periods of time, team members might not able to resolve or close bugs.|- Are team priorities correctly set?<br />- Are team members overallocated on other tasks?<br />- Are team members correctly tracking their bug status?|
113113
|**Bug assignments are not evenly distributed**. The team might need to reassign work when a large number of bugs are assigned to one or two team members and only a few to other team members.|- Does the team need to balance the workload by reassigning bugs?|
114114
|**The number of active higher priority bugs is larger than the number of active lower priority bugs**. When the number of high priority bugs is much larger than the number of lower priority bugs, work might be progressing on lower priority items first.|- Is the team fixing bugs in the order of priority set by the team?<br />- Are issues blocking the team's ability to fix the higher priority bugs?|
115115

116-
## <a name="Changing"></a> Filtering the Report and Changing the Display
116+
## <a name="Changing"></a> Filter the report and change the display
117117
You can filter the Bug Status report or change its display in the following ways:
118118

119119
- Change the start and end dates for the report.
@@ -126,24 +126,24 @@ After the team has started to find and fix bugs, you can track the team's progre
126126

127127
![Filters for Bug Status](media/procguid_bugstatus.png "ProcGuid_BugStatus")
128128

129-
#### To filter the set of bugs that are counted in the report
129+
### To filter the set of bugs that are counted in the report
130130

131-
1. Perform one or both of the following actions:
131+
1. Carry out one or both of the following actions:
132132

133133
- In the **Iteration** and **Area** lists, select the check box of each iteration or product area to include.
134134

135135
- In the **State**, **Priority**, and **Severity** lists, select the check box of each state, priority, and severity to include.
136136

137-
2. Click **View Report**.
137+
2. Select **View Report**.
138138

139-
#### To group bugs by priority or severity
139+
### To group bugs by priority or severity
140140

141-
1. In the **Group Active By** list, click **Priority** or **Severity**.
141+
1. In the **Group Active By** list, select **Priority** or **Severity**.
142142

143-
2. Click **View Report**.
143+
2. Select **View Report**.
144144

145145
## Related articles
146-
[Bugs](/previous-versions/azure/devops/report/sharepoint-dashboards/bugs-dashboard-agile-cmmi)
146+
147147
[Bugs](/previous-versions/azure/devops/report/sharepoint-dashboards/bugs-dashboard-agile-cmmi)
148148
[Workbooks](/previous-versions/azure/devops/report/sharepoint-dashboards/workbooks)
149149
[Bug Trends](bug-trends-report.md)

0 commit comments

Comments
 (0)