Create Layer 9 Data Contracts with Markdown and YAML files.
npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-ctr
Please help me install this Agent Skill. Skill: doc-ctr Source: https://github.com/vladm3105/aidoc-flow-framework/tree/main/.claude/skills/doc-ctr Command: npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-ctr
This Skill defines Data Contracts (CTR) that specify APIs and data schemas, providing a dual-file format (MD + YAML) when needed to ensure precise interface definitions and contract testing.
Create a CTR with API endpoints and corresponding YAML schema, linked to REQ IDs.
High-intent search queries and answers about installing and using this skill.
API contracts formalize endpoint definitions, data models, and validation rules using OpenAPI 3.0 or JSON Schema. Create a dual-file format (Markdown + YAML) with structured sections including Document Control, Contract Overview, Business Context, Contract Definition, Usage Examples, Validation Rules, Error Handling, and Traceability to establish precise, verifiable interface specifications across distributed systems.
Data Contracts are essential when multiple teams share APIs, building microservices or distributed systems requiring formal interface documentation. Apply CTR when business requirements, specifications, and implementation artifacts exist upstream, ensuring traceable contracts that enable contract testing and integration planning between services.
Link CTR documents to REQ, SPEC, and TASKS artifacts using traceability sections within the contract structure. This establishes bidirectional mapping between business requirements, formal specifications, and implementation tasks, enabling teams to verify that APIs fulfill original requirements and support downstream deployment validation.
The dual-file format uses Markdown for human-readable documentation (sections, context, examples, rationale) and YAML for machine-readable schema definitions and validation rules. This combination enables both team collaboration and automated contract testing while maintaining a single source of truth for interface specifications.
Yes. CTR includes structured Validation Rules and Error Handling sections that define constraints, data types, required fields, and error responses. These machine-readable specifications enable contract testing frameworks to automatically validate API payloads and enforce consistent error behavior across microservices.
Data Contracts require upstream artifacts—business requirements documents (BRD), specifications, and implementation tasks—to establish context and traceability. This ensures contracts reflect agreed-upon business intent and link technical interface definitions to organizational requirements and deployment plans.
Snowflake-LabsA concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略
ArabelaTsoGenerate and validate OpenAPI 3.0 YAML/JSON interface specifications.
mgd34msuGenerate TypeScript types and client SDKs from OpenAPI 3.1 specifications.
abdullah1854Generate Markdown Architectural Decision Records with context, decision, consequences, and alternatives.
