provider-docs-hashicorp-agent-skills

一、基本信息

二、功能介绍与亮点

本技能指导 Agent 为 Terraform Provider 生成、更新并校验 Terraform Registry 上的官方文档，遵循 HashiCorp 推荐的 tfplugindocs 模板与 schema 描述规范。

核心亮点：① 给出完整的七步工作流——从确认文档目标（Provider 索引、资源、数据源、Ephemeral Resource、List Resource、Function、Guide 七类文档对象）到编写 schema 字段描述、维护 docs/*.md.tmpl 模板、运行 tfplugindocs 生成、校验生成结果、再到 Registry 发布规则与故障排查；② 明确列出各类文档对象对应的官方推荐模板路径，避免生成无实现依据的空文档；③ 强调“schema 描述先行”——把用户可见的字段说明写进代码 schema，保证生成文档与实现行为始终同步，不依赖手工维护重复内容；④ 单列 Registry 发布规则（语义化版本 tag、terraform-registry-manifest.json 必须存在于仓库根目录等实操细节）与文档缺失时的排查步骤；⑤ 正文之外附带一份按需加载的参考文档 references/hashicorp-provider-docs.md，收录官方规则与链接来源。

三、适用场景

固定分类：工程效率与代码质量

适用于正在为 Terraform Provider 编写或维护 Registry 官方文档的 Go 开发者：新增资源/数据源/函数后需要同步生成文档、发现 Registry 页面文档缺失或过期需要排查、或需要按 HashiCorp 官方模板规范整理现有文档结构时。注意：本技能面向“开发 Provider 本身”的文档产出环节，而非普通 Terraform 使用者编写基础设施配置文档。

四、跨 Agent 兼容性

五、推荐理由

HashiCorp 官方把“如何让生成文档与 Provider 实现保持同步”这一件容易做错却缺乏统一规范的事，沉淀成一份贯穿 schema 描述、模板维护、生成校验到 Registry 发布规则的完整工作流参考。

六、评分

安全检查清单：

正文指导执行的命令限定在本地文档生成范围内、用途可解释，无联网外发目标、License 清晰，且为官方出品可审计，定为 8 分。

七、跟同类 Skills 相比的优势

核心差异化：通用 Terraform 技能面向“使用 Terraform 的人”，本技能是专门面向“开发 Terraform Provider 并需要向 Registry 发布官方文档”这一细分群体的参考，市面上少有同等颗粒度的独立替代品。

八、用户评价

该技能目前在第三方社区平台尚无具名用户评分或点评，但其诞生过程有可追溯的具名社区讨论：贡献者 drewmullen 于 2026 年 1 月在仓库 issue #14（“provider development improvements”）中明确提出“需要补充使用文档生成插件编写文档的指导”这一诉求，随后 bbasata、ffalor 等社区参与者围绕该主题持续讨论，同年 4 月该技能由贡献者 leefowlercu 开发并合并上线；2026 年 7 月，社区成员 AdamTylerLynch 在同一 issue 中确认该诉求已通过本技能等改进落地。

九、其他补充

本技能与同目录下的 provider-actions、provider-test-patterns、new-terraform-provider、provider-resources、run-acceptance-tests 共同打包为 Claude Code 插件 terraform-provider-development@hashicorp，覆盖 Provider 开发从脚手架、资源实现、Actions、测试验收到文档发布的完整链路。

十、安装使用方式

方式一：npx skills 通用安装

npx skills add hashicorp/agent-skills/terraform/provider-development/skills/provider-docs

方式二：Claude Code 插件市场

claude plugin marketplace add hashicorp/agent-skills
claude plugin install terraform-provider-development@hashicorp

安装后无需重启，Agent 在为 Terraform Provider 编写或校验 Registry 文档时会自动加载本技能。

十一、注意事项

• 面向已熟悉 Go、Terraform Plugin Framework 与 tfplugindocs 工具链的 Provider 开发者，非面向普通 Terraform 使用者
• 正文未内嵌可直接复制运行的完整代码示例，实际使用需结合具体 Provider 代码库中的 schema 定义
• 目前仅有 Claude Code 的官方安装命令经直接验证；Codex、OpenClaw、Hermes Agent 的支持结论来自对分发所用安装工具源码的核实，非各 Agent 官方文档直接确认