skills.rest
Kevin-Liu-01
Kevin-Liu-01COMMUNITY
Explore all skills by this author →
Website𝕏@kevskgsGitHub

generate-interface

Define subsystem interfaces with README-first contracts and clear ownership.

16|3|Updated May 5, 2026
Search Tags:#design#ownership#readme#docs#contracts#interface
One-click install
npx skills add https://github.com/Kevin-Liu-01/Agent-Machines --skill generate-interface
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-interface
Source: https://github.com/Kevin-Liu-01/Agent-Machines/tree/main/knowledge/skills/generate-interface
Command: npx skills add https://github.com/Kevin-Liu-01/Agent-Machines --skill generate-interface

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Define or refactor subsystem interfaces into small, explicit contracts with clear ownership, narrow scope, stable semantics, and README-first documentation. Use when designing a new API, collapsing ad hoc module boundaries into a few coherent interfaces, hardening internal contracts, or rewriting subsystem docs so engineers can understand the system by reading README.md files, docstrings, and code only.

Core Features & Use Cases

  • One contract per real responsibility
  • One authority per state field or operation
  • README-first subsystem manuals
  • Docstrings explaining interface ownership
  • Code that follows the contract over ad hoc helpers
  • Durable interfaces that are transport-agnostic

Quick Start

Start by identifying the subsystem’s primary surfaces and draft a README-first contract that assigns ownership and state to each interface.

Frequently Asked Questions about generate-interface

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

FAQPage Schema
How do I define subsystem interfaces to prevent scope creep?▼

Use README-first contracts to define subsystem interfaces, ensuring one contract per real responsibility and clear authority. This approach prevents scope creep by keeping module boundaries narrow and explicit.

What is the best way to document API boundaries for a new subsystem?▼

Draft README-first subsystem manuals to document API boundaries, assigning ownership and state to each interface. This ensures engineers understand the system through README.md files and docstrings.

How do I refactor ad hoc module boundaries into coherent contracts?▼

Collapse ad hoc module boundaries into a few coherent interfaces with clear ownership and stable semantics. Transport-agnostic contracts ensure code follows the defined boundaries over ad hoc helpers.

Does this interface design approach work across different programming languages?▼

Yes, this approach keeps the codebase cohesive across languages and transports by enforcing transport-agnostic contracts. Durable interfaces define boundaries independent of specific transport mechanisms.

When do I need to harden internal subsystem contracts?▼

Harden internal subsystem contracts when designing a new API, collapsing ad hoc module boundaries, or rewriting subsystem docs. This clarifies authority and ownership to prevent scope creep.

Why should I use README-first documentation for API delineation?▼

Use README-first documentation for API delineation to ensure engineers understand the system through README.md files and docstrings. It establishes one authority per state field or operation, keeping interfaces explicit.

Related Skills

Explore More Software Engineering Skills→
simonwjacksonsimonwjackson

se-zoom-out

Maps modules, primary callers, and key domain concepts from code.

Community
Intermediate
aaronjullger-lgtmaaronjullger-lgtm

ui-primitive-consolidation

Consolidate scattered UI patterns into reusable primitives across PANaCEa.

Community
Advanced
iamcapoteiamcapote

develop-secure-contracts

Integrate OpenZeppelin security patterns into Solidity, Cairo, Stylus, and Stellar smart contracts.

Community
Advanced
ZhanlinCuiZhanlinCui
178

mcp-builder

Design MCP servers with TypeScript or Python tool registration and transports.

Community
Advanced