Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/agents/blogs-docs.agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Blog-Docs-Writer
description: Specialized agent for creating new documentation, editing existing documentation, and writing blog posts for new features.
tools: ['read', 'search', 'edit']
---

You are a documentation specialist designed to write technical documentation, edit technical documentation, and summarize new features for blog blurbs or standalone blog posts. If you are editing or creating documentation, you create a pull request at the end of the creation process. Do not create a pull request until the content has been approved.

1. **First determine**
- Does the user want to create docs, edit docs, create a blog blurb, a standalone blog, or some combination of the above? These are the only actions you can do.

2. **Next ask for**
- Does the user have specifications, related documentation, or other content that can be used for reference?
- If there are no specifications, can the user describe the feature and the necessary elements for the document to be created?
- If creating new docs, which type of document (how-to, tutorial, conceptual, quickstart, overview) does the user want to create?
- Are there ideal examples of this kind of document within the repo?

3. Create a work plan, including outline. Do not proceed until the user has approved. Take into account the following general structures:

**Blog blurb**
- What is the feature and why should I care
- Screenshots
- Link to learn more in documentation

**Standalone blog**
- an expanded version of the blog blurb
- include scenarios for when to use this feature and how it can be used in conjunction with other parts of the product
- include a next steps section for users to get started

**New document**
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
- Use Microsoft style guide rules when writing
- Use templates in the ~/.github/agents/templates folder for the selected type.

4. Now create the requested documents

**File Types You Work With:**
- markdown (.md)
- images (.png) - all images must be hosted in the media/doc-file-name folder and embedded using the following example syntax: :::image type="content" source="media\add-source-sample-data-enhanced\add-sample-data.png" alt-text="A screenshot of selecting Sample data to add to an existing eventstream.":::
- table of contents files of type .yml
- text output for blog posts

**Pull request**
- If you are creating new documentation or updating existing, after the document is done then you must create a pull request (PR) under the user's fork against the main branch of the microsoft fork
- If you are creating a blog, return the content as text. Do not create a PR.
102 changes: 102 additions & 0 deletions .github/agents/templates/concept.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
title: [Follow SEO guidance at
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
description: "[Article description]."
author: [your GitHub alias]
ms.author: [your Microsoft alias or a team alias]
ms.service: [the approved service name]
ms.topic: concept-article #Don't change.
ms.date: [mm/dd/yyyy]

#customer intent: As a <role>, I want <what> so that <why>.

---

<!-- --------------------------------------

- Use this template with pattern instructions for:

Concept

- Before you sign off or merge:

Remove all comments except the customer intent.

- Feedback:

https://aka.ms/patterns-feedback

-->

# [noun phrase] concept(s)

or

# [noun] overview

<!-- Required: Article headline - H1

Identify the product, service, or feature the
article covers.

-->

[Introduce and explain the purpose of the article.]

<!-- Required: Introductory paragraphs (no heading)

Write a brief introduction that can help the user
determine whether the article is relevant for them
and to describe the concept the article covers.

For definitive concepts, it's better to lead with a
sentence in the form, "X is a (type of) Y that does Z."

-->

## Prerequisites

<!--Optional: Prerequisites - H2

If this section is needed, make "Prerequisites" your
first H2 in the article.

Use clear and unambiguous language and use
an unordered list format.

-->

## [Main idea]

[Describe a main idea.]

<!-- Required: Main ideas - H2

Use one or more H2 sections to describe the main ideas
of the concept.

Follow each H2 heading with a sentence about how
the section contributes to the whole. Then, describe
the concept's critical features as you define what it is.

-->

## Related content

- [Related article title](link.md)
- [Related article title](link.md)
- [Related article title](link.md)

<!-- Optional: Related content - H2

Consider including a "Related content" H2 section that
lists links to 1 to 3 articles the user might find helpful.

-->

<!--

Remove all comments except the customer intent
before you sign off or merge to the main branch.

-->
125 changes: 125 additions & 0 deletions .github/agents/templates/how-to.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
---
title: [Follow SEO guidance at
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
description: "[Article description]."
author: [your GitHub alias]
ms.author: [your Microsoft alias or a team alias]
ms.service: [the approved service name]
ms.topic: how-to #Don't change
ms.date: [mm/dd/yyyy]

#customer intent: As a <role>, I want <what> so that <why>.

---

<!-- --------------------------------------

- Use this template with pattern instructions for:

How To

- Before you sign off or merge:

Remove all comments except the customer intent.

- Feedback:

https://aka.ms/patterns-feedback

-->

# "[verb] * [noun]"

<!-- Required: Article headline - H1

Identify the product or service and the task the
article describes.

-->

[Introduce and explain the purpose of the article.]

<!-- Required: Introductory paragraphs (no heading)

Write a brief introduction that can help the user
determine whether the article is relevant for them
and to describe the task the article covers.

-->

## Prerequisites

<!-- Optional: Prerequisites - H2

If included, "Prerequisites" must be the first H2 in the article.

List any items that are needed to complete the How To,
such as permissions or software.

If you need to sign in to a portal to complete the How To,
provide instructions and a link.

-->

## "[verb] * [noun]"

[Introduce the procedure.]

1. Procedure step
1. Procedure step
1. Procedure step

<!-- Required: Steps to complete the task - H2

In one or more H2 sections, organize procedures. A section
contains a major grouping of steps that help the user complete
a task.

Begin each section with a brief explanation for context, and
provide an ordered list of steps to complete the procedure.

If it applies, provide sections that describe alternative tasks or
procedures.

-->

## Clean up resources

<!-- Optional: Steps to clean up resources - H2

Provide steps the user can take to clean up resources that
they might no longer need.

-->

## Next step -or- Related content

> [!div class="nextstepaction"]
> [Next sequential article title](link.md)

-or-

* [Related article title](link.md)
* [Related article title](link.md)
* [Related article title](link.md)

<!-- Optional: Next step or Related content - H2

Consider adding one of these H2 sections (not both):

A "Next step" section that uses 1 link in a blue box
to point to a next, consecutive article in a sequence.

-or-

A "Related content" section that lists links to
1 to 3 articles the user might find helpful.

-->

<!--

Remove all comments except the customer intent
before you sign off or merge to the main branch.

-->
80 changes: 80 additions & 0 deletions .github/agents/templates/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: [Follow SEO guidance at
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
description: "[Article description]."
author: [your GitHub alias]
ms.author: [your Microsoft alias or a team alias]
ms.service: [the approved service name]
ms.topic: overview #Don't change
ms.date: [mm/dd/yyyy]

#customer intent: As a <role>, I want <what> so that <why>.

---

<!-- --------------------------------------

- Use this template with pattern instructions for:

Overview

- Before you sign off or merge:

Remove all comments except the customer intent.

- Feedback:

https://aka.ms/patterns-feedback

-->

# What is [product or service]?

<!-- Required: Article headline - H1

Identify the product or service and the feature area
you are providing overview information about.

-->

[Introduce and explain the purpose of the article.]

<!-- Required: Introductory paragraphs (no heading)

Write a brief introduction that can help the user
determine whether the article is relevant for them
and to describe how the article might benefit them.

-->

## [Feature section]

[Introduce a section that describes a feature.]

<!-- Required: Feature sections - H2

In two or more H2 sections, describe key features of
the product or service. Consider sections for basic
requirements, dependencies, limitations, and overhead.

-->

## Related content

- [Related article title](link.md)
- [Related article title](link.md)
- [Related article title](link.md)

<!-- Optional: Related content - H2

Consider including a "Related content" H2 section that
lists links to 1 to 3 articles the user might find helpful.

-->

<!--

Remove all comments except the customer intent
before you sign off or merge to the main branch.

-->
Loading