sg-template-docs

You can generate Terraform template documentation automatically by running a skill that analyzes module files like variables.tf and outputs.tf to populate technical README content. It extracts variable definitions and module configurations to produce well-structured docs without manual writing.

Creating user-facing DOCUMENTATION.md from schema definitions is best handled by parsing input_schema.json and ui_schema.json to extract user-facing parameters. This approach ensures the resulting documentation reflects the module's configuration for quick publishing.

Yes, this documentation generation approach works specifically with StackGuardian templates. It analyzes the module sources and schema definitions to ensure the resulting docs follow the prescribed structure for prerequisites, configuration, outputs, security, and usage.

You can generate both developer and user documentation for a Terraform module simultaneously by analyzing module files and schemas together. This produces a developer-facing README.md and a user-facing DOCUMENTATION.md, aligning both documents in one run.

Before auto-generating module documentation, you need to prepare Terraform files including variables.tf, outputs.tf, and versions.tf. You also need schema definitions in schemas/input_schema.json and ui_schema.json to populate the technical and user-facing content accurately.