Skip to content

Commit 1f921b4

Browse files
authored
Add How To article template
This file serves as a template for creating 'How To' articles, including sections for prerequisites, procedures, and related content.
1 parent 78cfc91 commit 1f921b4

File tree

1 file changed

+125
-0
lines changed

1 file changed

+125
-0
lines changed

.github/agents/templates/how-to.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: [Follow SEO guidance at
3+
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
4+
description: "[Article description]."
5+
author: [your GitHub alias]
6+
ms.author: [your Microsoft alias or a team alias]
7+
ms.service: [the approved service name]
8+
ms.topic: how-to #Don't change
9+
ms.date: [mm/dd/yyyy]
10+
11+
#customer intent: As a <role>, I want <what> so that <why>.
12+
13+
---
14+
15+
<!-- --------------------------------------
16+
17+
- Use this template with pattern instructions for:
18+
19+
How To
20+
21+
- Before you sign off or merge:
22+
23+
Remove all comments except the customer intent.
24+
25+
- Feedback:
26+
27+
https://aka.ms/patterns-feedback
28+
29+
-->
30+
31+
# "[verb] * [noun]"
32+
33+
<!-- Required: Article headline - H1
34+
35+
Identify the product or service and the task the
36+
article describes.
37+
38+
-->
39+
40+
[Introduce and explain the purpose of the article.]
41+
42+
<!-- Required: Introductory paragraphs (no heading)
43+
44+
Write a brief introduction that can help the user
45+
determine whether the article is relevant for them
46+
and to describe the task the article covers.
47+
48+
-->
49+
50+
## Prerequisites
51+
52+
<!-- Optional: Prerequisites - H2
53+
54+
If included, "Prerequisites" must be the first H2 in the article.
55+
56+
List any items that are needed to complete the How To,
57+
such as permissions or software.
58+
59+
If you need to sign in to a portal to complete the How To,
60+
provide instructions and a link.
61+
62+
-->
63+
64+
## "[verb] * [noun]"
65+
66+
[Introduce the procedure.]
67+
68+
1. Procedure step
69+
1. Procedure step
70+
1. Procedure step
71+
72+
<!-- Required: Steps to complete the task - H2
73+
74+
In one or more H2 sections, organize procedures. A section
75+
contains a major grouping of steps that help the user complete
76+
a task.
77+
78+
Begin each section with a brief explanation for context, and
79+
provide an ordered list of steps to complete the procedure.
80+
81+
If it applies, provide sections that describe alternative tasks or
82+
procedures.
83+
84+
-->
85+
86+
## Clean up resources
87+
88+
<!-- Optional: Steps to clean up resources - H2
89+
90+
Provide steps the user can take to clean up resources that
91+
they might no longer need.
92+
93+
-->
94+
95+
## Next step -or- Related content
96+
97+
> [!div class="nextstepaction"]
98+
> [Next sequential article title](link.md)
99+
100+
-or-
101+
102+
* [Related article title](link.md)
103+
* [Related article title](link.md)
104+
* [Related article title](link.md)
105+
106+
<!-- Optional: Next step or Related content - H2
107+
108+
Consider adding one of these H2 sections (not both):
109+
110+
A "Next step" section that uses 1 link in a blue box
111+
to point to a next, consecutive article in a sequence.
112+
113+
-or-
114+
115+
A "Related content" section that lists links to
116+
1 to 3 articles the user might find helpful.
117+
118+
-->
119+
120+
<!--
121+
122+
Remove all comments except the customer intent
123+
before you sign off or merge to the main branch.
124+
125+
-->

0 commit comments

Comments
 (0)