design-interface

Generate formal interface contracts from architecture documents and entity definitions.

52|3|Updated Feb 14, 2026

Search Tags:#architecture #documentation #api-design #interface-contracts #boundary-design #logical-entities

Ready to run

npx skills add https://github.com/ZTE-AICloud/Co-OmniSpec --skill design-interface-zte-aicloud

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: design-interface
Source: https://github.com/ZTE-AICloud/Co-OmniSpec/tree/main/skills/design-interface
Command: npx skills add https://github.com/ZTE-AICloud/Co-OmniSpec --skill design-interface-zte-aicloud

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

将逻辑实体的能力边界转化为对外与内部的接口契约，并给出变更规则，便于版本化与协作。仅在显式调用时触发，不自动执行。

Core Features & Use Cases

接口契约抽象：将能力语义、输入输出、调用场景、处理流程和代码映射等要素规范化为对外接口和内部接口的契约。
架构合规校验：对照架构文档校验暴露层级与依赖边界，确保边界清晰。
契约生成与变更记录：生成契约文档并记录变更，支持增删改查的追溯性。
Use Case：在设计阶段为新实体产出接口边界，并在实现阶段指导模块协作。

Quick Start

直接显式调用 design-interface 以生成给定逻辑实体的对外/内部接口契约。

Frequently Asked Questions about design-interface

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

FAQPage Schema

How do I generate formal interface contracts from logical entities?▼

To generate interface contracts, you analyze logical entity boundaries and map capabilities, inputs/outputs, processing flows, and code mappings into a formal specification document with defined change rules.

What is interface contract design for boundary architecture?▼

Interface contract design is the process of translating logical entity capabilities into formal external and internal boundaries, ensuring clear exposure levels and dependency constraints for cross-team collaboration.

How do I document API change rules for versioning and collaboration?▼

Document API change rules by generating a contract specification that records traceable additions, deletions, and modifications, mapping capabilities and flows to support version control across teams.

Do I need architecture documents to define interface boundaries?▼

Yes, architecture documents and entity definitions are required inputs to validate exposure levels and dependency boundaries, ensuring the generated interface contracts align with architectural compliance.

When should I use automated contract generation for API design?▼

Use automated contract generation during the design phase to establish interface boundaries for new entities and during the implementation phase to guide structured module collaboration across teams.

Can I use this approach to validate architecture compliance for logical entities?▼

Yes, you can validate architecture compliance by checking generated interface contracts against architecture documents to verify that exposure levels and dependency boundaries remain clear and consistent.