Client Docs logo

Client Docs

Community
jh941213
client-docs

고객 제출용 SI/AO 산출물(아키텍처설계서, 인터페이스설계서, DB설계서, 요구사항추적표, 테스트결과서, 매뉴얼, 운영보고서)을 요청받았을 때 사용. 검수·납품·산출물 요청 시 발동. 상시 생성이 아닌 온디맨드 — 요청받은 산출물만 만든다

Overview

Publisherjh941213
Repositorymy-cc-harness
Skill nameclient-docs
Stars
125
Forks
35
Bundled files
Instructions only
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.

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

Use it in TypingMind

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

Client-Docs (고객 제출 산출물 온디맨드 생성)

원칙: 산출물은 자주 안 만든다. 요청받은 그 산출물만, 이미 있는 원재료(docs/·코드·실행 결과)에서 변환 생성한다.

산출물 라우팅

산출물원재료 (없으면 먼저 생성)비고
아키텍처설계서docs/ARCHITECTURE.md + 구성도 + ERD (없으면 /docs arch 먼저)
인터페이스설계서docs/api/ OpenAPI 명세 (없으면 /docs api 먼저)내외부 연계 목록 포함
DB설계서ERD + 모델/마이그레이션 코드 → 테이블정의서 표
요구사항정의서/추적표(RTM)SPEC.md·PRD.md + 요구사항↔구현(파일/커밋)↔테스트 매핑매핑 근거 없이 칸 채우기 금지
단위/통합테스트결과서실제 테스트 실행 출력 (pytest/CI 로그)실행하지 않은 결과 기재 절대 금지 — 증거 기반 완료 보고 원칙
사용자/운영자 매뉴얼docs/manuals/, docs/ops/ (없으면 /docs manual·ops 먼저)
운영보고서(AO)AUDIT.log, 장애·변경 기록, git log기간을 사용자에게 확인

생성 규칙

  1. 출력 위치: {project}/deliverables/[산출물명]_[YYYY-MM-DD].md
  2. 공통 골격: 표지(사업명·작성일·버전) → 개정이력 → 목차 → 본문 → 첨부. 본문 구조는 산출물 유형별 관례를 따른다
  3. 고객 양식이 있으면 양식 우선: ~/.claude/templates/client/ 또는 {project}/templates/에 고객사 템플릿이 있으면 그 구조·항목명을 그대로 따른다. 없으면 위 공통 골격의 마크다운으로 생성 (추후 엑셀/워드 변환은 pandoc 등으로)
  4. 사실만 기재: 코드·docs·실행 결과에서 확인된 내용만. 확인 안 된 항목은 비워두고 [확인 필요]로 표시 — 그럴듯하게 채우지 않는다
  5. 원재료가 낡았으면 먼저 /docs sync 후 산출물 생성
  6. 생성 후 memory/INDEX.md에 deliverables/ 라우팅 행이 없으면 추가 (키워드: 산출물,검수,납품)
  7. 검수 수준 요건 (독립 평가에서 도출된 반려 방지 규칙):
    • 테스트결과서는 집계표만으로 부족 — 케이스별 상세(ID·테스트명·판정)를 별첨으로 포함 (실제 -v 출력에서 생성)
    • 커버리지는 측정 명령과 범위를 명시하고, tests/ 포함 수치만 단독 기재 금지 — 소스 패키지 기준 수치를 병기 (분모 차이로 2배 부풀려 읽힐 수 있음)
    • 결재란(작성/검토/승인)과 요구사항 추적성 매트릭스 골격 포함 — 값이 없으면 [확인 필요]로
  8. 생성 후 가능하면 별도 에이전트로 사실 대조(수치 재현) 검증 — 생성자가 자기 산출물을 채점하지 않는다

진입점

  • 슬래시 명령: /client-docs [arch|api|db|rtm|test|manual|ops|report]
  • 자연어: "검수 산출물", "납품 문서", "테스트결과서 뽑아줘" 등의 요청 시 이 스킬로 라우팅

금지

  • 요청 안 받은 산출물까지 일괄 생성 (온디맨드 원칙)
  • 실행하지 않은 테스트 결과·검증하지 않은 수치 기재
  • docs/ 원본 수정 (산출물은 deliverables/에만 생성 — 원본은 /docs 계열이 소유)

Frequently asked questions

What does the Client Docs AI skill do?

고객 제출용 SI/AO 산출물(아키텍처설계서, 인터페이스설계서, DB설계서, 요구사항추적표, 테스트결과서, 매뉴얼, 운영보고서)을 요청받았을 때 사용. 검수·납품·산출물 요청 시 발동. 상시 생성이 아닌 온디맨드 — 요청받은 산출물만 만든다

Why use Client Docs on TypingMind?

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

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

Which AI models can use Client Docs?

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 Client Docs?

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

Is the Client Docs 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 👇