Docs Architecture logo

Docs Architecture

Community
jh941213
docs-architecture

아키텍처 문서 생성/갱신 — ARCHITECTURE.md(코드맵), 아키텍처 구성도(C4 mermaid), ADR(MADR), 데이터 모델 ERD. 아키텍처 문서/구성도 작성·갱신, ADR 기록, ERD/데이터 모델 문서화, 구조적 리팩토링 후 문서 반영이 필요할 때. API 명세는 docs-interfaces, 사용자/운영 매뉴얼은 docs-manuals, 코드 구현에는 사용하지 않음

Overview

Publisherjh941213
Repositorymy-cc-harness
Skill namedocs-architecture
Stars
125
Forks
35
Bundled files
2
Links
  • 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.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by jh941213 on GitHub. Read the source before you install it.

Installation

Install the Docs Architecture 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-architecture .claude/skills/docs-architecture
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Docs Architecture 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 Architecture 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 Architecture 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.

아키텍처 문서 스킬

프로젝트의 구조적 사실을 문서화한다. 산출물은 docs/ 아래, 다이어그램은 mermaid(레포에서 네이티브 렌더).

입력

$ARGUMENTS

산출물 선택 (결정 트리)

상황산출물
소규모 프로젝트(<10k LOC)README 아키텍처 섹션 + 컨텍스트 다이어그램 1개면 충분 — 과잉 문서화 금지
기여자가 길을 잃는 규모docs/ARCHITECTURE.md (코드맵)
시스템 경계/외부 연동 설명 필요C4 Context + Container 다이어그램
중요한 설계 결정 발생docs/design-docs/ADR-NNN-[제목].md (MADR)
영속 데이터 구조 변경docs/ARCHITECTURE.md 내 ERD 섹션 또는 docs/data-model.md
대규모/규제 시스템arc42 12섹션 문서 (명시 요청 시에만)

ARCHITECTURE.md 작성 규칙 (코드맵)

  1. 지도이지 지도책이 아니다 — 굵직한 모듈과 관계만. 파일별 나열 금지
  2. 먼저 "이 시스템이 푸는 문제"를 조감, 그다음 코드맵
  3. 중요 심볼은 이름만 언급, 하이퍼링크 금지 (링크는 썩는다 — 독자는 심볼 검색을 쓴다)
  4. 아키텍처 불변식을 명시 (예: "domain 레이어는 infra를 import하지 않는다")
  5. 코드를 읽으면 아는 것은 쓰지 않는다 — 구조만으로 알 수 없는 결정/이유를 쓴다

구조:

markdown
# Architecture

## 개요        ← 시스템이 푸는 문제, 1-2문단
## 구성도      ← C4 Context/Container mermaid
## 코드맵      ← 모듈별 역할 + 경계 (디렉토리 ≈ 문단 1개)
## 불변식      ← 지켜야 할 구조 규칙
## 크로스커팅  ← 로깅, 에러 처리, 인증 등 공통 관심사

다이어그램

mermaid 문법과 관례는 references/mermaid-conventions.md 참조 (C4Context/C4Container, sequenceDiagram, erDiagram, architecture-beta).

핵심 관례:

  • 다이어그램 1개 = 관심사 1개, 노드 15-20개 이하
  • C4는 Context → Container 2레벨까지가 기본. Component 레벨은 flowchart + subgraph가 더 잘 그려짐
  • 인프라/배포 토폴로지는 architecture-beta 우선

ADR (MADR 형식)

  • 위치: docs/design-docs/ADR-NNN-[kebab-제목].md — 번호는 3자리 제로패딩 (예: ADR-001-use-postgres.md), docs/design-docs/index.md에 인덱스 갱신
  • 템플릿: templates/adr.md (기본은 minimal — Context/Decision/Consequences. 논쟁적 결정만 full MADR)
  • ADR은 불변 — 뒤집을 땐 새 ADR로 supersede, 기존 문서 수정 금지
  • status: proposed → accepted → superseded by ADR-NNN

실행 절차

  1. 대상 파악: 인자 없으면 git diff --name-only HEAD~5..HEAD + 프로젝트 구조 스캔으로 변경된 구조 요소 탐지
  2. 기존 docs/ARCHITECTURE.md가 있으면 Edit로 갱신 (전면 재작성 금지 — 변경된 섹션만)
  3. 다이어그램의 노드가 실제 코드 구조와 일치하는지 확인 후 생성
  4. docs/docs.yaml 매니페스트 갱신 (없으면 생성):
    yaml
    docs:
      - path: docs/ARCHITECTURE.md
        covers: ["src/**", "!src/**/*.test.*"]
        last_reviewed: 2026-07-27
  5. 설명은 한국어, 코드/식별자는 원문

제약

  • docs/ 폴더만 수정. 소스 코드 수정 금지
  • 추측으로 다이어그램을 그리지 않는다 — 코드에서 확인한 관계만

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Docs Architecture AI skill do?

아키텍처 문서 생성/갱신 — ARCHITECTURE.md(코드맵), 아키텍처 구성도(C4 mermaid), ADR(MADR), 데이터 모델 ERD. 아키텍처 문서/구성도 작성·갱신, ADR 기록, ERD/데이터 모델 문서화, 구조적 리팩토링 후 문서 반영이 필요할 때. API 명세는 docs-interfaces, 사용자/운영 매뉴얼은 docs-manuals, 코드 구현에는 사용하지 않음

Why use Docs Architecture on TypingMind?

Because you install it once and use it with any model. Docs Architecture 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 Architecture in TypingMind?

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

Which AI models can use Docs Architecture?

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 Architecture?

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

Is the Docs Architecture 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

Set up your own AI workspace now

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