Design an Interface

Designs the public interface of a module before any implementation exists: writes the caller scenarios first, produces three candidates with genuinely different shapes, type-checks each one against the scenarios, scores them on measurable criteria and records the decision. Use when someone says "design the API for this module", "what should this signature look like", "compare interface options", "this function is awkward to call", "show me alternatives before I build it", or is about to add a module, library entry point, endpoint or command that other code will depend on.

213 stars 34 forksSoftware Development

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add TerminalSkills/skills --skill design-an-interface
Manual install
git clone --depth 1 https://github.com/TerminalSkills/skills.git /tmp/skills
mkdir -p ~/.claude/skills
cp -r /tmp/skills/skills/design-an-interface ~/.claude/skills/design-an-interface

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Design an Interface

## Overview

An interface is everything a caller must know to use a module: the names, the parameter and result types, the order calls have to happen in, how failures show up, and what is promised to stay stable. It is the part that costs most to change later, because every caller is written against it. This skill explores the alternatives while they are still free: caller scenarios come first, then three candidates of different shape, then a proof that each candidate can express the scenarios, a scored comparison and a short decision record. No implementation is written at any point.

## Instructions

### 1. Collect the facts

Read the project before asking anything:

- **Callers.** Search for existing or future call sites (`grep -rn "sendNotification(" src/`), count them, and note which arguments vary and which are always the same.
- **House conventions.** How do neighbouring modules report errors (exceptions or result values), are they async, how are dependencies passed in, how are things named?
- **Stability promise.** If every caller lives in this repository the interface can change later with one refactoring commit. If it is published (a package, a public HTTP route, a CLI) every incompatible change costs a major version under Semantic Versioning and a migration for people you cannot reach.
Read the full skill on GitHub

Details

Skill name
design-an-interface
Path
skills/design-an-interface/SKILL.md
License
Apache-2.0
Repo updated
8 November 2026

FAQ

What does the Design an Interface skill do?

Designs the public interface of a module before any implementation exists: writes the caller scenarios first, produces three candidates with genuinely different shapes, type-checks each one against the scenarios, scores them on measurable criteria and records the decision. Use when someone says "design the API for this module", "what should this signature look like", "compare interface options", "this function is awkward to call", "show me alternatives before I build it", or is about to add a module, library entry point, endpoint or command that other code will depend on.

How do I install the Design an Interface skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add TerminalSkills/skills --skill design-an-interface. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Design an Interface popular?

It lives in TerminalSkills/skills, which has 213 GitHub stars and 34 forks.

Related skills

3dsmax Rendering

213

TerminalSkills/skills

Scripts and configures production rendering in Autodesk 3ds Max with the V-Ray and Corona renderers: output size and files, render elements, denoising, light mix, batch and command-line rendering, and network rendering. Use when a user asks to set up a production render, render several cameras in one batch, render from the command line or on a render farm, add render passes for compositing, or cut render time for archviz and product shots.

Other34

3dsmax Scripting

213

TerminalSkills/skills

Covers scripting Autodesk 3ds Max, the 3D modeling and rendering application, with MAXScript and Python (pymxs): scene manipulation, object creation, material assignment, camera and light setup, batch operations, and file I/O. Use when tasks involve automating repetitive 3ds Max workflows, batch processing scenes, running scripts headless with 3dsmaxbatch, creating custom tools, or scripting scene setup for archviz, product visualization, or VFX.

Productivity & Notes34

3proxy

213

TerminalSkills/skills

3proxy is a small open-source proxy server that runs HTTP/HTTPS, SOCKS4/5, SNI and TCP/UDP port-mapping proxies from one config file. Use when a user asks to set up an HTTP or SOCKS5 proxy, add proxy users and passwords, write 3proxy access rules, chain or rotate upstream (parent) proxies, limit bandwidth, connections or monthly traffic per user, run 3proxy in Docker, or fix a 3proxy.cfg that will not start.

DevOps & Cloud34

Devcontainers

213

TerminalSkills/skills

Define reproducible development environments with Dev Containers. Use when a user asks to standardize dev environments, set up VS Code remote containers, create reproducible dev setups, or onboard developers faster.

Software Development34

Deno

213

TerminalSkills/skills

Assists with building secure JavaScript and TypeScript applications using the Deno runtime. Use when creating servers, CLI tools, or scripts with Deno's built-in tooling, permission model, npm compatibility, and web standards APIs. Trigger words: deno, deno deploy, deno serve, deno kv, deno permissions, secure runtime, jsr.

Software Development34

Directus

213

TerminalSkills/skills

Build backends and APIs with Directus headless CMS. Use when a user asks to create a headless CMS, build a content API without coding, set up a backend admin panel, create REST or GraphQL APIs from a database, manage content with roles and permissions, build a data platform with auto-generated APIs, or replace traditional CMS with a headless solution. Covers data modeling, auto-generated REST/GraphQL APIs, roles/permissions, flows (automation), file storage, and SDK integration.

Software Development34

Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.