gendoc-gen-contracts

Extract documentation-driven contracts and output OpenAPI YAML, JSON Schema, Pact, and IaC skeletons.

Updated Apr 22, 2026
One-click install
npx skills add https://github.com/ibalasite/gendoc --skill gendoc-gen-contracts
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gendoc-gen-contracts
Source: https://github.com/ibalasite/gendoc/tree/main/skills/gendoc-gen-contracts
Command: npx skills add https://github.com/ibalasite/gendoc --skill gendoc-gen-contracts

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Extract and assemble machine-readable contracts (OpenAPI, JSON Schema, Pact, and IaC/Seed code) from gendoc-driven documentation, eliminating manual assembly and drift.

Core Features & Use Cases

  • Generates OpenAPI 3.1 YAML, JSON Schema, Pact contracts, and IaC skeletons from BRD/IDEA/EDD/ARCH documentation
  • Provides reproducible pipelines and traceability by attaching sources, versions, and provenance to artifacts
  • Use Case: teams CI-ship contract artifacts directly from design docs to ensure alignment between docs and implemented services

Quick Start

Run the gendoc-gen-contracts workflow to generate all machine-readable contracts from your documentation.

Frequently Asked Questions about gendoc-gen-contracts

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

FAQPage Schema
How do I generate OpenAPI and Pact contracts from project documentation?

Generate OpenAPI and Pact contracts from project documentation by running the workflow to extract machine-readable artifacts from BRD, IDEA, EDD, and ARCH docs, outputting them under docs/blueprint with source traceability.

How do I automate JSON Schema and IaC skeleton extraction from design docs?

Automate JSON Schema and IaC skeleton extraction by reading upstream gendoc-driven documentation suites, validating them against class diagrams and deployment specs to produce reproducible contract artifacts.

Can I use documentation-driven contracts to eliminate manual API spec assembly?

Documentation-driven contracts eliminate manual API spec assembly by automatically extracting and assembling OpenAPI YAML, JSON Schema, and Pact files from your design docs to prevent drift between documentation and services.

Does the contract generation pipeline validate artifacts against class diagrams and deployment specs?

The contract generation pipeline validates extracted artifacts against class diagrams and deployment specs, ensuring traceability, validation, and reproducibility by reading upstream docs and attaching sources, versions, and provenance.

What is the best way to CI-ship contract artifacts directly from design docs?

The best way to CI-ship contract artifacts from design docs is to run the automated extraction workflow, which outputs OpenAPI, JSON Schema, Pact contracts, and IaC seeds directly from your BRD and EDD files.