Add conceptual and overview templates

This commit is contained in:
Gordon Hogenson 2022-12-08 14:34:20 -08:00
Родитель c741254d26
Коммит 8464639b06
2 изменённых файлов: 136 добавлений и 0 удалений

62
docs/templates/conceptual.md поставляемый Normal file
Просмотреть файл

@ -0,0 +1,62 @@
---
title: #Required; page title is displayed in search results. Include the brand.
description: #Required; article description that is displayed in search results.
author: #Required; your GitHub user alias, with correct capitalization.
ms.author: #Required; microsoft alias of author; optional team alias.
ms.service: #Required; service per approved list. slug assigned by ACOM.
ms.topic: conceptual #Required; leave this attribute/value as-is.
ms.date: #Required; mm/dd/yyyy format.
ms.custom: template-concept #Required; leave this attribute/value as-is.
---
<!--Remove all the comments in this template before you sign-off or merge to the
main branch.
This template provides the basic structure of a Concept article pattern. See the [instructions - Concept](../level4/article-concept.md) in the pattern library.
To provide feedback on this template contact
[the templates workgroup](mailto:ghogen@microsoft.com).
-->
<!-- 1. H1
Required. Set expectations for what the content covers, so customers know the
content meets their needs. Should NOT begin with a verb.
-->
# [H1 heading here] concepts
<!-- 2. Introductory paragraph
Required. Lead with a light intro that describes what the article covers. Answer the
fundamental “why would I want to know this?” question. Keep it short.
-->
[add your introductory paragraph]
<!-- 3. H2s
Required. Give each H2 a heading that sets expectations for the content that follows.
Follow the H2 headings with a sentence about how the section contributes to the whole.
-->
## [Section 1 heading]
<!-- add your content here -->
## [Section 2 heading]
<!-- add your content here -->
## [Section n heading]
<!-- add your content here -->
<!-- 4. Next steps
Required. Provide at least one next step and no more than three. Include some
context so the customer can determine why they would click the link.
-->
## Next steps
<!-- Add a context sentence for the following links, e.g. "Learn more about ..." -->
- [Write concepts](article-concept.md)
- [Links](../contribute/links-how-to.md)
<!--
Remove all the comments in this template before you sign-off or merge to the
main branch.
-->

74
docs/templates/overview.md поставляемый Normal file
Просмотреть файл

@ -0,0 +1,74 @@
---
title: #Required; page title displayed in search results. Include the brand.
description: #Required; article description that is displayed in search results.
author: #Required; your GitHub user alias, with correct capitalization.
ms.author: #Required; microsoft alias of author; optional team alias.
ms.service: #Required; service per approved list. service slug assigned to your service by ACOM.
ms.topic: overview #Required
ms.date: #Required; mm/dd/yyyy format.
---
<!--
Remove all the comments in this template before you sign-off or merge to the
main branch.
This template provides the basic structure of a Overview article pattern. See the [instructions - Overview](../level4/article-overview.md) in the pattern library.
You can provide feedback about this template at: mailto:ghogen@microsoft.com
1. H1 -----------------------------------------------------------------------------
Required: For the H1 - that's the primary heading at the top of the article - use the format "What is <service>?"
You can also use this in the TOC if your service name doesnt cause the phrase to wrap.
-->
<!---
--->
# <area> overview
TODO: Add your heading
<!-- 2. Introductory paragraph ----------------------------------------------------------
Required: The introductory paragraph helps customers quickly determine whether an article is relevant.
Describe in customer-friendly terms what the service is and does, and why the customer should care. Keep it short for the intro.
You can go into more detail later in the article. Many services add artwork or videos below the introduction.
-->
[Introductory paragraph]
TODO: Add your introductory paragraph
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.--->
<!-- 3. Article body ------------------------------------------------------------
Required: After the intro, you can develop your overview by discussing the features that answer the "Why should I care" question with a bit more depth.
Be sure to call out any basic requirements and dependencies, as well as limitations or overhead.
Don't catalog every feature, and some may only need to be mentioned as available, without any discussion.
-->
[Article body]
TODO: Add your article body
<!-- Top tasks ------------------------------------------------------------------------------
Suggested:
An effective way to structure you overview article is to create an H2 for the top customer tasks you identified during the [planning process](../contribute/content-dev-plan.md) and describe how the product/service helps customers with that task.
Create a new H2 for each task you list. Task
headings should start with an imperative verb, not a gerund (-ing form), e.g. "Configure a command" not "Configuring a command".
Use H3s for subareas within each task to break up.
--->
## Task heading
<!-- 5. Next steps ------------------------------------------------------------------------
Required: In Overview articles, provide at least one next step.
Next steps in overview articles will often link to a tutorial or a conceptual article.
What you link to will depend on what is really a next step for the customer.
Do not use a "More info section" or a "Resources section" or a "See also section".
--->
## Next steps
TODO: Add your next step link(s)