Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when adding or changing provider configuration, resources, data sources, ephemeral resources, list resources, functions, actions, or guides; when validating generated docs; and when troubleshooting missing or incorrect Registry documentation.
需要具備 Go 工具鏈的 Terraform Provider 儲存庫，以及 tfplugindocs 產生器（透過 go generate 或 go run 執行）。此技能未附指令碼，僅引用隨附的參考文件與代理程式設定檔。
Terraform Provider Docs
Follow This Workflow
Confirm scope and documentation targets.
Map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources, functions, actions, or guides.
Decide whether content should come from schema descriptions, templates, or both.
Write schema descriptions first.
Add precise user-facing descriptions to schema fields so generated docs stay aligned with behavior.
Keep wording specific to argument purpose, constraints, defaults, and computed behavior.
Add or update template files in docs/.
Create only files that map to implemented provider objects.
Use HashiCorp-recommended template paths:
docs/index.md.tmpl
docs/data-sources/<name>.md.tmpl
docs/resources/<name>.md.tmpl
docs/ephemeral-resources/<name>.md.tmpl
docs/list-resources/<name>.md.tmpl
docs/functions/<name>.md.tmpl
docs/actions/<name>.md.tmpl (tfplugindocs generates action docs with Terraform v1.14.0+)
docs/guides/<name>.md.tmpl
Keep templates focused on overview and examples; rely on generated sections for field-by-field details.
Keep HCL examples in the examples/ directory — one example per file, pulled into templates with tffile — rather than inlined in templates (see Example File Conventions in references/hashicorp-provider-docs.md). Examples must not contain terraform, provider, or output blocks.
For action pages, follow the structure in references/hashicorp-provider-docs.md (Action Pages section): examples must show both the action block and the action_trigger lifecycle wiring, and actions get no attribute/output section.
Generate documentation with tfplugindocs.
Prefer repository defaults when configured:
bash
go generate ./...
Otherwise run the generator directly:
bash
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name>
Re-run generation after every schema or template edit.
Validate the generated markdown.
Verify files in docs/ match the current provider implementation.
Verify examples are valid HCL and reflect current argument/attribute names.
Verify required/optional/computed semantics in docs match schema behavior.
Apply Registry publication rules before release.
Use semantic version tags prefixed with v (for example v1.2.3).
Create release tags from the default branch.
Keep terraform-registry-manifest.json in the repository root.
Expect docs to be versioned in Registry and switchable with the version selector.
Preview or troubleshoot publication when needed.
Use the HashiCorp preview process to inspect rendered docs before release when accuracy risk is high.
If docs are missing in Registry, check tag format, tag source branch, manifest file presence, and provider publication status.
Enforce Quality Bar
Keep documentation behaviorally accurate; never describe unsupported arguments or attributes.
Keep examples minimal, realistic, and runnable.
Keep terminology and naming consistent across provider, resources, and data sources.
Avoid duplicating generated argument/attribute blocks in manual templates.
Keep doc changes tied to the same PR as schema/API changes whenever possible.
Load References On Demand
Read references/hashicorp-provider-docs.md for source-backed rules and official links.
Load only the sections needed for the current change to keep context lean.
