azurerm-docs-writer

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.

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.

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.

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.

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.

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.