CtrlK
BlogDocsLog inGet started
Tessl Logo

provider-docs

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.

76

Quality

96%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

92%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, lean skill body: an explicit 7-step workflow with validation and feedback loops, concrete commands and template paths, and proper one-level-deep reference disclosure. The only weakness is that the validation and preview steps describe what to check without giving executable commands or section pointers, keeping actionability just short of fully copy-paste ready.

Suggestions

In step 5, make validation executable: give the concrete check commands (e.g. how to validate example HCL, such as `terraform fmt -check` on examples/ or re-running tfplugindocs and diffing docs/) instead of only describing what to verify.

In step 7, link the preview and troubleshooting detail the way the templates step does — e.g. "follow the Preview and Troubleshooting section in `references/hashicorp-provider-docs.md`" — so "Use the HashiCorp preview process" has an actionable pointer.

Consider moving the Terraform v1.14.0+ compatibility note for action docs into the referenced Action Pages section to keep version-sensitive details out of the overview body.

DimensionReasoningScore

Conciseness

The 72-line body is pure directive guidance — no explanation of concepts Claude already knows (no "Terraform is..." padding), no fluff; every line states a rule, path, or command. The one version mention ("tfplugindocs generates action docs with Terraform v1.14.0+") is a necessary compatibility constraint, not date-conditional instruction, so it does not warrant a penalty. Not 4: there is no over-explanation left to trim.

5 / 5

Actionability

Core workflow is executable and copy-paste ready: exact template paths (docs/index.md.tmpl, docs/resources/<name>.md.tmpl, etc.), `go generate ./...`, and the full `go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name>` invocation. Not 5: step 5's validations are descriptive rather than executable ("Verify examples are valid HCL" names no command such as a fmt/validate check), and "Use the HashiCorp preview process" points to a process without linking the reference section that explains it. Not 3: the generation and file-layout guidance is fully concrete, not pseudocode.

4 / 5

Workflow Clarity

A clearly sequenced 7-step workflow with an explicit validation step (step 5 lists three concrete checks), a feedback loop ("Re-run generation after every schema or template edit"), and a recovery path (step 7 troubleshooting with a specific diagnostic checklist: tag format, tag source branch, manifest file, publication status). Matches the anchor-5 pattern of sequence + explicit validation + error-recovery loop.

5 / 5

Progressive Disclosure

The body is a lean overview that defers source-backed detail to a single, clearly signaled, one-level-deep reference (`references/hashicorp-provider-docs.md`, verified to exist with the exact sections cited: "Example File Conventions" and "Action Pages"), and instructs loading only needed sections. Not 4: structure, signaling, and file split are all appropriate with no organization gaps.

5 / 5

Total

19

/

20

Passed

Description

100%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

An exemplary description: third-person, concise, concrete about capabilities and tooling, and with an explicit, comprehensive "Use when" clause covering authoring, validation, and troubleshooting triggers. It closely matches the rubric's good examples and has no over-claims or filler.

DimensionReasoningScore

Specificity

"Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions" lists multiple specific concrete actions plus the exact mechanisms (tfplugindocs, templates, schema descriptions), giving comprehensive coverage. Not 4: the action list and tooling coverage go beyond "several specific actions; minor gaps".

5 / 5

Completeness

Explicitly answers both: what ("Create, update, and review Terraform provider documentation for Terraform Registry..." with named tooling) and when ("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"). Matches the anchor-5 example structure exactly.

5 / 5

Trigger Term Quality

Natural terms a Terraform practitioner would actually say are comprehensively covered: "provider documentation", "Terraform Registry", "provider configuration", "resources", "data sources", "ephemeral resources", "list resources", "functions", "actions", "guides", "tfplugindocs", "validating generated docs", "troubleshooting missing or incorrect Registry documentation". Not 4: no common variation of the domain vocabulary is missing.

5 / 5

Distinctiveness Conflict Risk

Clear niche (Terraform provider documentation for the Registry) with distinct triggers — tfplugindocs, template paths, Registry publication — that no general Terraform or documentation skill would share. Minimal conflict risk. Not 4: the tool- and Registry-specific vocabulary leaves essentially no overlap with neighboring skills.

5 / 5

Total

20

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

Total

15

/

16

Passed

Repository
hashicorp/agent-skills
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.