azurerm-docs-writer

Generate and refine Markdown documentation for terraform-provider-azurerm resources and data sources.

6|7|Updated Oct 24, 2025

Search Tags:#documentation #markdown #azure #terraform #provider development #hashicorp style

Ready to run

npx skills add https://github.com/WodansSon/terraform-azurerm-ai-assisted-development --skill azurerm-docs-writer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: azurerm-docs-writer
Source: https://github.com/WodansSon/terraform-azurerm-ai-assisted-development/tree/main/.github/skills/azurerm-docs-writer
Command: npx skills add https://github.com/WodansSon/terraform-azurerm-ai-assisted-development --skill azurerm-docs-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and maintenance of documentation for the Terraform AzureRM provider, ensuring consistency with HashiCorp's standards and the provider's schema.

Core Features & Use Cases

Documentation Generation: Creates or updates Markdown documentation pages for resources and data sources.
Schema Parity: Ensures documentation accurately reflects the Terraform schema.
Style Enforcement: Adheres to HashiCorp's documentation style guide, including Oxford commas, canonical phrasing for boolean fields, and correct block placement.
Use Case: When adding a new resource to the AzureRM provider, use this Skill to generate its initial documentation, including example usage, arguments, and attributes, ensuring it meets all style and structural requirements.

Quick Start

Use the azurerm-docs-writer skill to update the documentation for the azurerm_resource_group resource.

Frequently Asked Questions about azurerm-docs-writer

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

FAQPage Schema

How do I generate documentation for a new AzureRM Terraform resource?▼

To generate documentation for a new AzureRM Terraform resource, use this Skill to create website/docs markdown files. It produces structured documentation including example usage, arguments, and attributes while enforcing schema parity and HashiCorp formatting conventions.

What is HashiCorp style guide compliance for Terraform provider docs?▼

HashiCorp style guide compliance for Terraform provider docs means adhering to specific formatting conventions, including Oxford commas, canonical boolean field phrasing, correct block placement, and accurate argument/attribute referencing to ensure structural consistency.

How do I ensure schema parity in AzureRM provider markdown files?▼

To ensure schema parity in AzureRM provider markdown files, this Skill performs detailed audits comparing your documentation against the Terraform schema. It verifies that documented arguments and attributes accurately reflect the underlying resource definitions.

Does this documentation generator support data sources as well as resources?▼

Yes, this documentation generator supports both resources and data sources within the terraform-provider-azurerm repository. It applies the same HashiCorp style enforcement, schema parity checks, and markdown formatting conventions to both types.

What's the best way to refine existing AzureRM Terraform documentation?▼

The best way to refine existing AzureRM Terraform documentation is using this Skill's audit functionality. It reviews current markdown pages against HashiCorp style guidelines and schema definitions, identifying discrepancies in argument referencing and formatting conventions.

Why do my Terraform provider docs fail style checks for boolean fields?▼

Terraform provider docs fail style checks for boolean fields when they lack canonical phrasing required by HashiCorp's guide. This Skill automatically enforces correct boolean field descriptions and block placement to prevent style validation failures.