About

Imported from terminalskills/skills (skills/design-an-interface/SKILL.md). Install upstream with npx skills add terminalskills/skills --skill design-an-interface. Copyright stays with the author (Apache-2.0).

Design an Interface

Name: design-an-interface
Author: terminalskills

Based on "Design It Twice" from "A Philosophy of Software Design": your first idea is unlikely to be the best. Generate multiple radically different designs, then compare.

Workflow

1. Gather Requirements

Before designing, understand:

What problem does this module solve?
Who are the callers? (other modules, external users, tests)
What are the key operations?
Any constraints? (performance, compatibility, existing patterns)
What should be hidden inside vs exposed?

Ask: "What does this module need to do? Who will use it?"

2. Generate Designs (Parallel Sub-Agents)

Spawn 3+ sub-agents simultaneously using Task tool. Each must produce a radically different approach.

Prompt template for each sub-agent:

Design an interface for: [module description]

Requirements: [gathered requirements]

Constraints for this design: [assign a different constraint to each agent]
- Agent 1: "Minimize method count - aim for 1-3 methods max"
- Agent 2: "Maximize flexibility - support many use cases"
- Agent 3: "Optimize for the most common case"
- Agent 4: "Take inspiration from [specific paradigm/library]"

Output format:
1. Interface signature (types/methods)
2. Usage example (how caller uses it)
3. What this design hides internally
4. Trade-offs of this approach

3. Present Designs

Show each design with:

Interface signature - types, methods, params
Usage examples - how callers actually use it in practice
What it hides - complexity kept internal

Present designs sequentially so user can absorb each approach before comparison.

4. Compare Designs

After showing all designs, compare them on:

Interface simplicity: fewer methods, simpler params
General-purpose vs specialized: flexibility vs focus
Implementation efficiency: does shape allow efficient internals?
Depth: small interface hiding significant complexity (good) vs large interface with thin implementation (bad)
Ease of correct use vs ease of misuse

Discuss trade-offs in prose, not tables. Highlight where designs diverge most.

5. Synthesize

Often the best design combines insights from multiple options. Ask:

"Which design best fits your primary use case?"
"Any elements from other designs worth incorporating?"

Evaluation Criteria

From "A Philosophy of Software Design":

Interface simplicity: Fewer methods, simpler params = easier to learn and use correctly.

General-purpose: Can handle future use cases without changes. But beware over-generalization.

Implementation efficiency: Does interface shape allow efficient implementation? Or force awkward internals?

Depth: Small interface hiding significant complexity = deep module (good). Large interface with thin implementation = shallow module (avoid).

Anti-Patterns

Don't let sub-agents produce similar designs - enforce radical difference
Don't skip comparison - the value is in contrast
Don't implement - this is purely about interface shape
Don't evaluate based on implementation effort

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/terminalskills-skills-design-an-interface/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

terminalskills-skills-design-an-interface.ocm.jsonjson

{
  "ocm": "1",
  "id": "terminalskills-skills-design-an-interface",
  "kind": "skill",
  "name": "design-an-interface",
  "description": "Generate multiple radically different interface designs for a module using parallel sub-agents. Use when: user wants to design an API, explore interface options, compare module shapes, or mentions \"design it twice\".",
  "publisher": "terminalskills",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "interface-design",
      "api-design",
      "deep-modules",
      "design-it-twice",
      "parallel-agents",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Generate multiple radically different interface designs for a module using parallel sub-agents. Use when: user wants to design an API, explore interface options, compare module shapes, or mentions \"design it twice\"."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/terminalskills/skills",
      "path": "skills/design-an-interface/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/terminalskills/skills/blob/HEAD/skills/design-an-interface/SKILL.md",
      "key": "terminalskills/skills/skills/design-an-interface/SKILL.md"
    },
    "compatibility": "Claude Code, any AI coding agent",
    "license": "Apache-2.0"
  },
  "instructions": "# Design an Interface\n\nBased on \"Design It Twice\" from \"A Philosophy of Software Design\": your first idea is unlikely to be the best. Generate multiple radically different designs, then compare.\n\n## Workflow\n\n### 1. Gather Requirements\n\nBefore designing, understand:\n\n- [ ] What problem does this module solve?\n- [ ] Who are the callers? (other modules, external users, tests)\n- [ ] What are the key operations?\n- [ ] Any constraints? (performance, compatibility, existing patterns)\n- [ ] What should be hidden inside vs exposed?\n\nAsk: \"What does this module need to do? Who will use it?\"\n\n### 2. Gen",
  "cost": {
    "context_tokens": 775
  }
}

Fetch it by URL: GET /api/v1/registry/terminalskills-skills-design-an-interface/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.