Docs Interfaces

Community

jh941213

docs-interfaces

Generate interface/API docs — OpenAPI 3.1/AsyncAPI 3.0 specs, API topology diagrams, interface flow (sequence) diagrams, API changelog. Use when writing API docs/specs (OpenAPI, swagger, AsyncAPI), interface/API topology diagrams, endpoint docs, API changelogs. Whole-system diagrams → docs-architecture; user manuals → docs-manuals; API design principles themselves → api-design-principles

Overview

Publisher	jh941213
Repository	`my-cc-harness`
Skill name	`docs-interfaces`
Stars	125
Forks	35
Bundled files	Instructions only
Links	Skill source Repository

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
Self-contained
Everything the model needs lives in the instructions — no extra files to sync.
Open source
Published by jh941213 on GitHub. Read the source before you install it.

Installation

Install the Docs Interfaces AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/jh941213/my-cc-harness.git /tmp/my-cc-harness
mkdir -p .claude/skills
cp -r /tmp/my-cc-harness/skills_en/docs-interfaces .claude/skills/docs-interfaces

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Docs Interfaces in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Docs Interfaces on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Docs Interfaces is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Interface/API Documentation Skill

Documents contracts between systems. The spec in Git is the single source of truth (docs-as-code).

Input

$ARGUMENTS

Artifact map

Target	Artifact	Location
REST API	OpenAPI 3.1 spec	`docs/api/openapi.yaml`
Event/message interfaces	AsyncAPI 3.0 spec	`docs/api/asyncapi.yaml`
API topology (inter-system calls)	C4 Container + per-flow sequence diagrams	`docs/api/README.md`
Human-readable reference	Per-endpoint markdown (inherits docs-writer's api.md format)	`docs/api/reference.md`
API change history	breaking/non-breaking + deprecation schedule	`docs/api/CHANGELOG.md`

Spec-first vs code-first

Multiple teams/external consumers → spec-first: author and review docs/api/openapi.yaml first; code follows the spec
Single-team internal service → code-first is fine, but the generated spec must be committed and diffed in CI (the drift gate is installed by the docs-ci skill)
Either way a spec file must exist in the repo — "the code is the doc" doesn't count

OpenAPI rules

Write from actual routes/schemas read from code — no guessing. Mark unverifiable fields with TODO comments
operationId required, group resources with tags, include 4xx/5xx responses
Examples must be real working values
Declare auth schemes (securitySchemes)
Don't force event-driven interfaces (queues, websockets, webhooks) into OpenAPI — split into AsyncAPI

API topology + flow diagrams

Inter-system topology: 1 C4 Container diagram
One sequence diagram per key flow (auth, order creation, …) — use the shared conventions in ../docs-architecture/references/mermaid-conventions.md
Include at least one error path (alt block) — never draw only the happy path

API CHANGELOG rules

markdown
## [v1.4.0] - 2026-07-27
### Breaking
- `GET /users` response: removed `nickname` → `profile.nickname` (migration: …)
### Added
- `POST /invoices/bulk`
### Deprecated
- `GET /v1/legacy-search` — sunset 2026-10-01

Breaking changes must ship with a migration path
If oasdiff is installed, draft with oasdiff changelog <base> <rev> then polish

Procedure

Find route/handler/schema files (**/routes/**, **/api/**, **/controllers/**, framework patterns)
If a spec exists, diff it against actual code → report mismatches first, then update
If new, generate an OpenAPI 3.1 skeleton → fill per resource
Write docs/api/README.md with topology + flow diagrams
Update docs/docs.yaml manifest entries for docs/api/* (covers: route path globs)
Validate the spec: npx @redocly/cli lint docs/api/openapi.yaml or npx @stoplight/spectral-cli lint (only if installed; otherwise skip and suggest docs-ci)

Constraints

Modify only docs/. Never touch source code
Never put endpoints in the spec that don't exist in code

Frequently asked questions

What does the Docs Interfaces AI skill do?

Why use Docs Interfaces on TypingMind?

Because you install it once and use it with any model. Docs Interfaces is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Docs Interfaces in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/jh941213/my-cc-harness/tree/main/skills_en/docs-interfaces. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Docs Interfaces?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Docs Interfaces?

As many as you like. As long as a model supports skills, you can use Docs Interfaces with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Docs Interfaces AI skill free?

It is published on GitHub by jh941213. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Claude Handoff

mattpocock

CommunityPopular

Hand the current conversation off to a fresh background agent that picks up the work immediately.

Finishing A Development Branch

obra

CommunityPopular

Use when implementation is complete, all tests pass, and you need to decide how to integrate the work

Receiving Code Review

obra

CommunityPopular

Use when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative…

Requesting Code Review

obra

CommunityPopular

Use when completing tasks, implementing major features, or before merging to verify work meets requirements

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Interface/API Documentation Skill

Input

Artifact map

Spec-first vs code-first

OpenAPI rules

API topology + flow diagrams

API CHANGELOG rules

Procedure

Constraints

Frequently asked questions

Related AI Skills

Set up your own AI workspace now