entity-requirements

Generate OpenSpec spec.md files from Terraform resource or data source implementations.

208|148|Updated Oct 27, 2021
One-click install
npx skills add https://github.com/elastic/terraform-provider-elasticstack --skill entity-requirements
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: entity-requirements
Source: https://github.com/elastic/terraform-provider-elasticstack/tree/main/.agents/skills/existing-entity-requirements
Command: npx skills add https://github.com/elastic/terraform-provider-elasticstack --skill entity-requirements

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of OpenSpec requirements by analyzing an existing Terraform resource or data source implementation and producing a standards-compliant specification under openspec/specs/.

Core Features & Use Cases

  • Analyzes code paths to capture behavior and generates an OpenSpec spec.md with sections for purpose, schema, and requirements.
  • Ensures traceability from implementation to documentation by linking to the resource path and code structure.
  • Useful for documenting existing resources or data sources on demand or for onboarding new team members.

Quick Start

Provide the Terraform entity (resource or data source) path, and run the skill to generate the OpenSpec requirements document.

Frequently Asked Questions about entity-requirements

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate OpenSpec requirements from existing Terraform code?

To generate OpenSpec requirements from existing Terraform code, provide the entity path and the skill analyzes the resource or data source implementation to produce a standards-compliant spec.md under openspec/specs.

Can I document Terraform resources built with both the plugin-framework and SDK?

Yes, you can document Terraform resources built with both the plugin-framework and SDK. The skill analyzes both entity types to capture attributes, CRUD behavior, and error handling into verifiable requirements.

What is the best way to auto-document Terraform resource schemas and behavior?

The best way to auto-document Terraform resource schemas and behavior is to analyze the code path directly, mapping attributes, CRUD operations, and error handling to a traceable OpenSpec specification.

Does generating OpenSpec documentation require manually writing the schema section?

No, generating OpenSpec documentation does not require manually writing the schema section. The skill derives the schema and requirements directly from the Terraform entity implementation code path.

Why use code analysis to create Terraform resource specifications instead of writing them manually?

Using code analysis to create Terraform resource specifications ensures traceability from implementation to documentation. It maps attributes and CRUD behavior directly to verifiable requirements, reducing manual documentation drift.

What limitations exist when auto-generating OpenSpec requirements from Terraform implementations?

A limitation when auto-generating OpenSpec requirements from Terraform implementations is that the output focuses on purpose, schema, and requirements sections derived directly from the code path, requiring existing implementation logic to be present.