Docs Manuals logo

Docs Manuals

Community
jh941213
docs-manuals

사용자 매뉴얼(Diátaxis)과 운영자 매뉴얼(런북, 배포 가이드, 설정 레퍼런스, 인시던트 플레이북) 생성. 사용자 매뉴얼/유저 가이드/튜토리얼, 운영자 매뉴얼, 런북(runbook), 배포 가이드, 온콜/인시던트 대응 문서가 필요할 때. API 명세는 docs-interfaces, 아키텍처 문서는 docs-architecture, docs CI 파이프라인은 docs-ci 사용

Overview

Publisherjh941213
Repositorymy-cc-harness
Skill namedocs-manuals
Stars
125
Forks
35
Bundled files
1
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.

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

Use it in TypingMind

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

사용자/운영자 매뉴얼 스킬

읽는 사람(최종 사용자 vs 운영자)과 읽는 상황(학습 중 vs 장애 대응 중)에 맞는 문서를 만든다.

입력

$ARGUMENTS

사용자 매뉴얼 — Diátaxis 4분면

핵심 규칙: 한 페이지에 두 모드를 섞지 않는다. 페이지를 쓰기 전에 먼저 분류하라:

분면목적형태위치
Tutorial학습 (처음 온 사람)따라하면 성공하는 수업. 선택지 없이 한 길docs/manuals/tutorials/
How-to과제 해결 ("X 하려면?")목표 지향 단계. 전제조건 명시docs/manuals/how-to/
Reference정보 조회사전식. 제품 구조를 그대로 반영docs/manuals/reference/
Explanation이해 ("왜 이렇게?")배경, 설계 이유, 트레이드오프docs/manuals/explanation/

트리거 매핑: 새 기능 → how-to + reference / 새 개념 → explanation / 온보딩 갭 → tutorial

인덱스는 docs/manuals/README.md — 4분면으로 내비게이션 구성.

운영자 매뉴얼

위치: docs/ops/

1. 운영 개요 (docs/ops/README.md)

  • 시스템 토폴로지 (docs-architecture의 배포 다이어그램 링크/포함)
  • 용량/스케일링 노트, 정상 상태 지표 기준선

2. 설정 레퍼런스 (docs/ops/configuration.md)

모든 환경변수/플래그를 표로 — 코드에서 추출 (.env.example, config 파일, process.env/os.environ grep):

이름타입기본값효과유효값

3. 런북 (docs/ops/runbooks/[알림명].md)

새벽 3시에 처음 보는 사람이 따라할 수 있어야 한다. 템플릿: templates/runbook.md

  • 알림당 1개 파일: 알림명/심각도/사용자 영향 → 진단(대시보드 링크 + 복붙 가능한 쿼리) → 완화(순서 있는 복붙 가능 명령 + 각 단계의 트레이드오프 경고) → 근본 해결/후속 → 에스컬레이션 경로
  • 새 알림 룰이 생기면 런북도 같은 PR로. 인시던트에서 사용된 런북은 사후 반드시 갱신

4. 배포 가이드 (docs/ops/deployment.md)

환경 목록, 파이프라인 설명, 롤아웃 절차, 배포 후 검증(스모크 체크 명령), 롤백 절차(가장 중요 — 복붙 가능하게)

5. 인시던트 플레이북 (docs/ops/incident-playbook.md)

심각도 매트릭스, 역할(지휘자/커뮤니케이션 담당), 커뮤니케이션 템플릿, 에스컬레이션 정책, 블레임리스 포스트모템 템플릿

실행 절차

  1. 대상 판별: 인자에서 사용자 문서인지 운영 문서인지, 특정 문서인지 전체인지
  2. 소스 수집: 코드(설정/알림 룰/배포 스크립트), 기존 docs/, CI 설정, docker/k8s 매니페스트
  3. 코드에서 확인한 사실만 기술 — 알 수 없는 운영 값(대시보드 URL, 온콜 로테이션)은 <!-- TODO: 운영팀 확인 --> 마커로 남기고 목록으로 보고
  4. 기존 문서는 Edit로 갱신, 신규만 Write
  5. docs/docs.yaml 매니페스트 갱신
  6. 설명은 한국어(또는 프로젝트 언어), 명령/식별자는 원문

제약

  • docs/ 폴더만 수정
  • 런북의 명령은 실제 실행 가능해야 함 — 존재하지 않는 스크립트/명령 금지
  • 페이지당 Diátaxis 분면 1개 — 혼합 감지 시 분리 제안

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 Manuals AI skill do?

사용자 매뉴얼(Diátaxis)과 운영자 매뉴얼(런북, 배포 가이드, 설정 레퍼런스, 인시던트 플레이북) 생성. 사용자 매뉴얼/유저 가이드/튜토리얼, 운영자 매뉴얼, 런북(runbook), 배포 가이드, 온콜/인시던트 대응 문서가 필요할 때. API 명세는 docs-interfaces, 아키텍처 문서는 docs-architecture, docs CI 파이프라인은 docs-ci 사용

Why use Docs Manuals on TypingMind?

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

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/jh941213/my-cc-harness/tree/main/skills/docs-manuals. 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 Manuals?

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

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

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

Internal Comms

anthropics
OrganizationPopular

A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal…

20.9K
176.9K
4 files
View
anthropics logo

Claude Opus 4 5 Migration

anthropics
OrganizationPopular

Migrate prompts and code from Claude Sonnet 4.0, Sonnet 4.5, or Opus 4.1 to Opus 4.5. Use when the user wants to update their codebase, prompts, or API calls to use Opus 4.5. Handles model string…

23.8K
146.3K
2 files
View
garrytan logo

Canary

garrytan
CommunityPopular

Post-deploy canary monitoring. (gstack)

19.9K
133.5K
1 files
View
garrytan logo

Land And Deploy

garrytan
CommunityPopular

Land and deploy workflow. (gstack)

19.9K
133.5K
8 files
View

Set up your own AI workspace now

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