Skip to content

Commit 59ebe0a

Browse files
Incorporate feedback.
1 parent ca901a4 commit 59ebe0a

File tree

1 file changed

+41
-37
lines changed

1 file changed

+41
-37
lines changed

docs/boards/queries/link-type-reference.md

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2-
title: Link types reference guide
2+
title: Link Types Reference Guide
33
titleSuffix: Azure Boards
4-
description: Reference guide that describes all link types defined for Azure DevOps and Azure Boards.
4+
description: Use this reference guide to understand all the link types defined for Azure DevOps and Azure Boards.
55
ms.service: azure-devops-boards
66
ms.custom: work-items, cross-project, cross-service, engagement-fy23
77
ms.assetid: 219717a0-de6e-4f70-8558-54f813f82507
88
ms.author: chcomley
99
author: chcomley
1010
ms.topic: conceptual
1111
monikerRange: '<= azure-devops'
12-
ms.date: 11/15/2023
12+
ms.date: 07/31/2025
13+
#customer intent: As a team member with organizational responsibilities, I want to understand the link types available in Azure DevOps and Azure Boards.
1314
---
1415

1516
# Reference guide for link types
@@ -18,7 +19,7 @@ ms.date: 11/15/2023
1819

1920
<a id="link-type-guidance"></a>
2021

21-
You can use different link types to manage the various relationships between work items and other artifacts, like builds, commits, pull requests, and more. In this article, we describe the following link types.
22+
You can use different link types to manage the various relationships between work items and other artifacts, like builds, commits, and pull requests. This article describes the following link types.
2223

2324
::: moniker range="azure-devops"
2425

@@ -43,17 +44,15 @@ A specific field maintains a count of links for the first three link types, such
4344

4445
::: moniker-end
4546

46-
47-
48-
Link types are subject to certain restrictions based on their topology. Use the guidance provided in the following tables to choose which link type to use based on the types of queries and reports you want to create. To learn more about the different topologies, see [Link type topologies and restrictions](/previous-versions/azure/devops/reference/xml/link-type-element-reference#topology).
47+
Link types are subject to restrictions based on their topology. Use the guidance provided in the following tables to choose which link type to use based on the types of queries and reports you want to create. To learn more about the different topologies, see [Link type topologies and restrictions](/previous-versions/azure/devops/reference/xml/link-type-element-reference#topology).
4948

5049
## Work link type
5150

5251
Work link types are system-defined, process-defined, or user-defined (custom). The links listed in the following table are system-defined.
5352

5453
Each work link type defines the link labels, topology type, and restrictions that are used when links between work items are constructed. For example, the parent-child link type defines two labels: Parent and Child. The link type also supports a hierarchical or tree topology, and prevents circular references from being created between work items.
5554

56-
![Conceptual image of a Work item link type.](media/link-type-reference/linkscontrol-work-item-link-types.png)
55+
:::image type="content" source="media/link-type-reference/linkscontrol-work-item-link-types.png" alt-text="Diagram is a conceptual image of a Work item link type.":::
5756

5857
A work item's *Related Link Count* corresponds to the sum of all links defined with a work link type.
5958

@@ -77,8 +76,8 @@ The following table describes the work item link types you can specify to scope
7776
---
7877
:::row:::
7978
:::column span="1":::
80-
**Affects-Affected by** (CMMI only) ![Conceptual image of Affects link type.](media/link-work-items-support-traceability/affects-cmmi.png)
81-
![Conceptual image of Affected by link type.](media/link-work-items-support-traceability/affected-by-cmmi.png)
79+
**Affects-Affected by** (CMMI only) :::image type="content" source="media/link-work-items-support-traceability/affects-cmmi.png" alt-text="Diagram is a conceptual image of Affects link type.":::
80+
:::image type="content" source="media/link-work-items-support-traceability/affected-by-cmmi.png" alt-text="Diagram is a conceptual image of Affected by link type.":::
8281
:::column-end:::
8382
:::column span="3":::
8483
Microsoft.VSTS.Common.Affects-Forward
@@ -90,7 +89,8 @@ The following table describes the work item link types you can specify to scope
9089

9190
Use this directional link to create links between any set of work items, but not ones that would create closed loops. Typically used to track change requests made to requirements.
9291

93-
Restrictions and recommendations:
92+
Restrictions and recommendations:
93+
9494
- You can link a change request to only one requirement using Affects. You can link requirements to as many child change requests as needed using Affected by.
9595
- Only use Affects-Affected by links to link work items in the same project. We recommend this action if you plan to use Excel to modify or update work item data.
9696

@@ -99,8 +99,8 @@ The following table describes the work item link types you can specify to scope
9999
:::row:::
100100
:::column span="1":::
101101
**Child-Parent**
102-
![Conceptual image of a Child link type.](media/link-work-items-support-traceability/child-tree-forward.png)
103-
![Conceptual image of a Parent link type.](media/link-work-items-support-traceability/parent-tree-reverse.png)
102+
:::image type="content" source="media/link-work-items-support-traceability/child-tree-forward.png" alt-text="Diagram is a conceptual image of a Child link type.":::
103+
:::image type="content" source="media/link-work-items-support-traceability/parent-tree-reverse.png" alt-text="Diagram is a conceptual image of a Parent link type.":::
104104
:::column-end:::
105105
:::column span="3":::
106106
System.LinkTypes.Hierarchy-Forward
@@ -118,17 +118,18 @@ The following table describes the work item link types you can specify to scope
118118
- Link tasks to PBIs, user stories, or requirements. Supports Backlog Overview, Stories Overview, and Requirements Overview reports.
119119

120120
Restrictions and recommendations:
121+
121122
- Use Excel to bulk edit both work items and parent-child links. See [Bulk add or modify work items with Excel](../backlogs/office/bulk-add-modify-work-items-excel.md).
122123
- A work item can have only one Parent. A parent work item can have many children.
123-
- Only use parent-child links to link work items in the same project. This action is recommended if you plan to use Excel to modify or update work item data.
124+
- Only use parent-child links to link work items in the same project. We recommend this action if you plan to use Excel to modify or update work item data.
124125

125126
:::column-end:::
126127
:::row-end:::
127128
:::row:::
128129
:::column span="1":::
129130
**Duplicate-Duplicate of**
130-
![Conceptual image of Duplicate of tree forward.](media/link-work-items-support-traceability/duplicate-tree-forward.png)
131-
![Conceptual image of Duplicate of tree reverse.](media/link-work-items-support-traceability/duplicate-of-tree-reverse.png)
131+
:::image type="content" source="media/link-work-items-support-traceability/duplicate-tree-forward.png" alt-text="Diagram is a conceptual image of Duplicate of tree forward.":::
132+
:::image type="content" source="media/link-work-items-support-traceability/duplicate-of-tree-reverse.png" alt-text="Diagram is a conceptual image of Duplicate of tree reverse.":::
132133
:::column-end:::
133134
:::column span="3":::
134135
System.LinkTypes.Duplicate-Forward
@@ -141,16 +142,17 @@ The following table describes the work item link types you can specify to scope
141142
Use this directional link to create one-to-many relationships between a single parent to one or more child items. Use to track tasks, bugs, or other work items that are duplicates of one another.
142143

143144
Restrictions and recommendations:
145+
144146
- A work item can have only one Duplicate.
145-
- Only use Duplicate or Duplicate Of links to link work items in the same project. This action is recommended if you plan to use Excel to modify or update work item data.
147+
- Only use Duplicate or Duplicate Of links to link work items in the same project. We recommend this action if you plan to use Excel to modify or update work item data.
146148

147149
:::column-end:::
148150
:::row-end:::
149151
:::row:::
150152
:::column span="1":::
151153
**Referenced By-References**
152-
![Conceptual image of Tested by link type.](media/link-work-items-support-traceability/tested-by-dependency-forward.png)
153-
![Conceptual image of Tests link type.](media/link-work-items-support-traceability/tests-dependency-reverse.png)
154+
:::image type="content" source="media/link-work-items-support-traceability/tested-by-dependency-forward.png" alt-text="Diagram is a conceptual image of Tested by link type.":::
155+
:::image type="content" source="media/link-work-items-support-traceability/tests-dependency-reverse.png" alt-text="Diagram is a conceptual image of Tests link type.":::
154156
:::column-end:::
155157
:::column span="3":::
156158
Microsoft.VSTS.TestCase.
@@ -167,15 +169,16 @@ The following table describes the work item link types you can specify to scope
167169
:::row:::
168170
:::column span="1":::
169171
**Related**
170-
![Conceptual image of Related link type.](media/link-work-items-support-traceability/related-network.png)
172+
:::image type="content" source="media/link-work-items-support-traceability/related-network.png" alt-text="Diagram is a conceptual image of Related link type.":::
171173
:::column-end:::
172174
:::column span="3":::
173175
System.LinkTypes.Related
174176
Topology type: Network
175177
Link category: System-defined
176178
:::column-end:::
177179
:::column span="3":::
178-
Use this nondirectional link to create links between any set of work items. Use to link work items that are at the same level, such as two user stories that define features that overlap one another. The Related link type creates simple relationships with few restrictions.
180+
Use this nondirectional link to create links between any set of work items. Use to link work items that are at the same level, such as two user stories that define features that overlap one another. The Related link type creates simple relationships with few restrictions.
181+
179182
- Relate work items that are at the same level, such as two user stories that define features that overlap one another.
180183
- Link work items that are defined in different projects and managed by different teams.
181184
- Find and view work items and their related work items in a two-tiered view.
@@ -186,8 +189,8 @@ The following table describes the work item link types you can specify to scope
186189
:::row:::
187190
:::column span="1":::
188191
**Successor-Predecessor**
189-
![Conceptual image of Successor dependency, forward.](media/link-work-items-support-traceability/successor-dependency-forward.png)
190-
![Conceptual image of Predecessor dependency, reverse.](media/link-work-items-support-traceability/predecessor-dependency-reverse.png)
192+
:::image type="content" source="media/link-work-items-support-traceability/successor-dependency-forward.png" alt-text="Diagram is a conceptual image of Successor dependency, forward.":::
193+
:::image type="content" source="media/link-work-items-support-traceability/predecessor-dependency-reverse.png" alt-text="Diagram is a conceptual image of Predecessor dependency, reverse.":::
191194
:::column-end:::
192195
:::column span="3":::
193196
System.LinkTypes.Dependency
@@ -204,17 +207,19 @@ The following table describes the work item link types you can specify to scope
204207
- Supports one-to-many relationships.
205208
- Find and view predecessor work items and their successor work items in a two-tiered, direct links query view.
206209

207-
Restrictions and recommendations:
210+
Restrictions and recommendations:
211+
208212
- An error appears when you attempt to create links that define circular relationships.
209213
- Create predecessor-successor links only to work items that are within the same project.
210-
You can create predecessor-successor links between work items that are defined in different projects. But, if you export a query to Excel, only those work items defined for the project for which the query is defined get imported.
214+
You can create predecessor-successor links between work items that are defined in different projects. But, if you export a query to Excel, only those work items defined for the project for which the query is defined get imported.
215+
211216
:::column-end:::
212217
:::row-end:::
213218
:::row:::
214219
:::column span="1":::
215220
**Tested by-Tests**
216-
![Conceptual image of Tested by link type.](media/link-work-items-support-traceability/tested-by-dependency-forward.png)
217-
![Conceptual image of Tests link type.](media/link-work-items-support-traceability/tests-dependency-reverse.png)
221+
:::image type="content" source="media/link-work-items-support-traceability/tested-by-dependency-forward.png" alt-text="Diagram is a conceptual image of Tested by link type.":::
222+
:::image type="content" source="media/link-work-items-support-traceability/tests-dependency-reverse.png" alt-text="Diagram is a conceptual image of Tests link type.":::
218223
:::column-end:::
219224
:::column span="3":::
220225
Microsoft.VSTS.Common.TestedBy-Forward
@@ -231,8 +236,8 @@ The following table describes the work item link types you can specify to scope
231236
:::row:::
232237
:::column span="1":::
233238
**Test Case-Shared Steps**
234-
![Conceptual image of Tested by link type.](media/link-work-items-support-traceability/tested-by-dependency-forward.png)
235-
![Conceptual image of Tests link type.](media/link-work-items-support-traceability/tests-dependency-reverse.png)
239+
:::image type="content" source="media/link-work-items-support-traceability/tested-by-dependency-forward.png" alt-text="Diagram is a conceptual image of Tested by link type.":::
240+
:::image type="content" source="media/link-work-items-support-traceability/tests-dependency-reverse.png" alt-text="Diagram is a conceptual image of Tests link type.":::
236241
:::column-end:::
237242
:::column span="3":::
238243
Microsoft.VSTS.TestCase.
@@ -253,8 +258,7 @@ The following table describes the work item link types you can specify to scope
253258

254259
A hyperlink can link a work item to any URL. The *Hyperlink Count* tracks the number of hyperlinks to a work item.
255260

256-
> [!div class="mx-imgBorder"]
257-
> ![Conceptual image of a Hyperlink.](media/link-type-reference/hyperlink.png)
261+
:::image type="content" source="media/link-type-reference/hyperlink.png" alt-text="Diagram is a conceptual image of a Hyperlink.":::
258262

259263
:::row:::
260264
:::column span="1":::
@@ -291,7 +295,7 @@ A hyperlink can link a work item to any URL. The *Hyperlink Count* tracks the nu
291295
External link types are system-defined link types that support linking work items to other objects stored within Azure DevOps as shown in the following image. A work item's *External Link Count* corresponds to the sum of all links defined with an external link type.
292296

293297
> [!div class="mx-imgBorder"]
294-
> ![Conceptual image of External link type.](media/link-type-reference/linkscontrol-external-link-types.png)
298+
> :::image type="content" source="media/link-type-reference/linkscontrol-external-link-types.png" alt-text="Diagram is a conceptual image of External link type.":::
295299
296300
> [!NOTE]
297301
> You can only use an external link type to link to an Azure DevOps object. To link work items to other objects outside of Azure DevOps, use a [hyperlink](#hyperlink).
@@ -541,7 +545,7 @@ GitHub link types are system-defined and support linking work items to GitHub ob
541545
::: moniker range=">= azure-devops-2020"
542546

543547
> [!div class="mx-imgBorder"]
544-
> ![Conceptual image of GitHub link type.](media/link-type-reference/linkscontrol-github-link-types.png)
548+
> :::image type="content" source="media/link-type-reference/linkscontrol-github-link-types.png" alt-text="Diagram is a conceptual image of GitHub link type.":::
545549
546550
::: moniker-end
547551

@@ -628,8 +632,8 @@ A work item's [*Remote Link Count*](linking-attachments.md#remote-link-count) co
628632
:::column span="":::
629633
**Consumes From-Produced For**
630634
(Dependency topology)
631-
![Conceptual image of Consumes From topology.](media/link-work-items-support-traceability/affected-by-cmmi.png)
632-
![Conceptual image of Produced For topology.](media/link-work-items-support-traceability/affects-cmmi.png)
635+
:::image type="content" source="media/link-work-items-support-traceability/affected-by-cmmi.png" alt-text="Diagram is a conceptual image of Consumes From topology.":::
636+
:::image type="content" source="media/link-work-items-support-traceability/affects-cmmi.png" alt-text="Diagram is a conceptual image of Produced For topology.":::
633637
:::column-end:::
634638
:::column span="":::
635639
System.LinkTypes.Remote.Dependency-Forward
@@ -644,7 +648,7 @@ A work item's [*Remote Link Count*](linking-attachments.md#remote-link-count) co
644648
:::row:::
645649
:::column span="":::
646650
**Remote Related**
647-
![Conceptual image of Remote Related topology.](media/link-work-items-support-traceability/related-network.png)
651+
:::image type="content" source="media/link-work-items-support-traceability/related-network.png" alt-text="Diagram is a conceptual image of Remote Related topology.":::
648652
:::column-end:::
649653
:::column span="":::
650654
System.LinkTypes.Remote.Related
@@ -821,7 +825,7 @@ The following table provides descriptions for each of the link type attributes r
821825
Names, `name`
822826
:::column-end:::
823827
:::column span="2":::
824-
Specifies the friendly name assigned to the link type(s). Directional links are defined in pairs, therefore include a forward and reverse name.
828+
Specifies the friendly name assigned to the link types. Directional links are defined in pairs, therefore include a forward and reverse name.
825829
:::column-end:::
826830
:::row-end:::
827831
:::row:::

0 commit comments

Comments
 (0)