Docs Interfaces logo

Docs Interfaces

Community
jh941213
docs-interfaces

인터페이스/API 문서 생성 — OpenAPI 3.1/AsyncAPI 3.0 명세, API 구성도, 인터페이스 흐름도(시퀀스), API 변경 이력. API 문서/명세(OpenAPI, swagger, AsyncAPI) 작성, 인터페이스·API 구성도, 엔드포인트 문서, API changelog가 필요할 때. 시스템 전체 구성도는 docs-architecture, 사용자 매뉴얼은 docs-manuals, API 설계 원칙 자체는 api-design-principles 사용

Overview

Publisherjh941213
Repositorymy-cc-harness
Skill namedocs-interfaces
Stars
125
Forks
35
Bundled files
Instructions only
Links
Skill sourceRepository
  • 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.

1

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.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. 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.
2

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/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.

인터페이스/API 문서 스킬

시스템 간 계약을 문서화한다. 명세는 Git이 단일 진실 소스(docs-as-code).

입력

$ARGUMENTS

산출물 맵

대상산출물위치
REST APIOpenAPI 3.1 명세docs/api/openapi.yaml
이벤트/메시지 인터페이스AsyncAPI 3.0 명세docs/api/asyncapi.yaml
API 구성도 (시스템 간 호출 관계)C4 Container + 핵심 플로우별 시퀀스 다이어그램docs/api/README.md
사람이 읽는 레퍼런스엔드포인트별 마크다운 (기존 docs-writer의 api.md 형식 계승)docs/api/reference.md
API 변경 이력breaking/non-breaking 구분 + deprecation 일정docs/api/CHANGELOG.md

Spec-first vs Code-first 판단

  • 여러 팀/외부가 계약을 소비 → spec-first: docs/api/openapi.yaml을 먼저 작성·리뷰, 코드가 명세를 따른다
  • 단일 팀 내부 서비스 → code-first 허용. 단, 코드에서 생성한 명세를 반드시 커밋하고 CI에서 diff (드리프트 게이트는 docs-ci 스킬이 설치)
  • 어느 쪽이든 명세 파일이 레포에 존재해야 한다 — "코드가 곧 문서"는 인정하지 않음

OpenAPI 작성 규칙

  1. 코드에서 실제 라우트/스키마를 읽고 작성 — 추측 금지. 확인 불가한 필드는 TODO 주석으로 표시
  2. operationId 필수, 태그로 리소스 그룹화, 4xx/5xx 응답 포함
  3. 예시(example)는 실제 동작하는 값으로
  4. 인증 스킴(securitySchemes) 명시
  5. 이벤트 기반 인터페이스(큐, 웹소켓, 웹훅)는 OpenAPI에 우겨넣지 말고 AsyncAPI로 분리

API 구성도 + 흐름도

  • 시스템 간 토폴로지: C4 Container 다이어그램 1개
  • 핵심 플로우(인증, 주문 생성 등)마다 시퀀스 다이어그램 1개 — 문법은 ../docs-architecture/references/mermaid-conventions.md 공용 관례 사용
  • 에러 경로(alt 블록)를 최소 1개 포함 — 행복 경로만 그리지 않는다

API CHANGELOG 규칙

markdown
## [v1.4.0] - 2026-07-27
### Breaking
- `GET /users` 응답에서 `nickname` 제거 → `profile.nickname` (마이그레이션: …)
### Added
- `POST /invoices/bulk`
### Deprecated
- `GET /v1/legacy-search` — 2026-10-01 sunset
  • breaking 변경은 반드시 마이그레이션 경로를 함께 기술
  • oasdiff가 설치돼 있으면 oasdiff changelog <base> <rev>로 초안 생성 후 다듬기

실행 절차

  1. 라우트/핸들러/스키마 파일 탐색 (**/routes/**, **/api/**, **/controllers/**, 프레임워크별 패턴)
  2. 기존 명세가 있으면 실제 코드와 대조 → 불일치 목록 먼저 보고 후 갱신
  3. 신규면 OpenAPI 3.1 골격 생성 → 리소스별 채움
  4. docs/api/README.md에 구성도 + 플로우 다이어그램
  5. docs/docs.yaml 매니페스트에 docs/api/* 항목 갱신 (covers: 라우트 경로 글롭)
  6. 명세 검증: npx @redocly/cli lint docs/api/openapi.yaml 또는 npx @stoplight/spectral-cli lint (설치돼 있을 때만, 없으면 스킵하고 docs-ci 설치 제안)

제약

  • docs/ 폴더만 수정. 소스 코드 수정 금지
  • 코드에 없는 엔드포인트를 명세에 넣지 않는다

Frequently asked questions

What does the Docs Interfaces AI skill do?

인터페이스/API 문서 생성 — OpenAPI 3.1/AsyncAPI 3.0 명세, API 구성도, 인터페이스 흐름도(시퀀스), API 변경 이력. API 문서/명세(OpenAPI, swagger, AsyncAPI) 작성, 인터페이스·API 구성도, 엔드포인트 문서, API changelog가 필요할 때. 시스템 전체 구성도는 docs-architecture, 사용자 매뉴얼은 docs-manuals, API 설계 원칙 자체는 api-design-principles 사용

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/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.

Related AI Skills

View all
anthropics logo

Pdf

anthropics
OrganizationPopular

Use this skill whenever the user wants to do anything with PDF files. This includes reading or extracting text/tables from PDFs, combining or merging multiple PDFs into one, splitting PDFs apart,…

20.9K
176.9K
10 files
View
anthropics logo

Pptx

anthropics
OrganizationPopular

Use this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting…

20.9K
176.9K
54 files
View
anthropics logo

Theme Factory

anthropics
OrganizationPopular

Toolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact…

20.9K
176.9K
11 files
View
anthropics logo

Xlsx

anthropics
OrganizationPopular

Use this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file…

20.9K
176.9K
51 files
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇