doc-writer

Name: doc-writer
Availability: InStock
Author: Microsoft

Enforce documentation structure and frontmatter conventions for Aspire MDX files.

187|81|Updated Oct 28, 2025

Search Tags:#documentation #MDX #Astro #writing-guidelines #Aspire #content-communication #Starlight

Ready to run

npx skills add https://github.com/microsoft/aspire.dev --skill doc-writer-microsoft

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/microsoft/aspire.dev/tree/main/.github/skills/doc-writer
Command: npx skills add https://github.com/microsoft/aspire.dev --skill doc-writer-microsoft

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The doc writer skill helps ensure Aspire's documentation is accurate, consistent, and maintainable by providing clear guidelines for creating user guides, integration docs, tutorials, and API references.

Core Features & Use Cases

Establishes a uniform writing standard across the Aspire docs site to improve readability.
Guides content authors on structure, tone, and formatting for MDX/MD files used by Astro/Starlight.
Use Case: a maintainer updates a getting-started guide and ensures it adheres to the defined frontmatter, component usage, and labeling conventions.

Quick Start

Open the repository section for Aspire docs and refer to this skill when drafting or editing content to ensure consistency.

Frequently Asked Questions about doc-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write Aspire documentation that meets MDX and Astro standards?▼

To write Aspire documentation properly, follow established guidelines for MDX files used by Astro and Starlight to ensure structure, tone, and formatting consistency. This enforces mandatory frontmatter and component usage for high-quality content.

What are the mandatory frontmatter and section conventions for aspire.dev docs?▼

Mandatory frontmatter and section conventions for aspire.dev docs require specific structure and labeling to maintain accuracy. Guidelines direct authors on proper component usage and formatting across user guides and API references.

How do I maintain consistency across Aspire user guides and API references?▼

Maintain consistency across Aspire user guides and API references by applying codified documentation best practices. This establishes a uniform writing standard that enforces mandatory frontmatter and component conventions to improve readability.

Can I use standard Markdown formatting for Aspire tutorials built with Starlight?▼

For Aspire tutorials built with Starlight, you must use MDX formatting rather than standard Markdown. Guidelines specify proper component usage, labeling conventions, and frontmatter structure to ensure content integration within the Astro framework.

Does the doc-writer skill apply to integration docs and getting-started guides?▼

Yes, the doc-writer skill applies directly to integration docs and getting-started guides. It ensures maintainers adhere to defined frontmatter, component usage, and labeling conventions when drafting or editing aspire.dev content.