Skip to content

Commit ec9062f

Browse files
committed
feat: 각 템플릿에 skills/commands 추가
1 parent f2a6cd4 commit ec9062f

54 files changed

Lines changed: 9408 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 239 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
---
2+
description: Claude Code 문서 작성 가이드. CLAUDE.md, SKILL.md 등 효과적인 문서 작성 시 사용.
3+
---
4+
5+
# Docs Creator
6+
7+
Claude Code 문서 작성 베스트 프랙티스 가이드.
8+
9+
## 핵심 원칙
10+
11+
| 원칙 | 설명 |
12+
|------|------|
13+
| **간결함** | 컨텍스트 윈도우는 공공재. 모든 토큰이 비용 |
14+
| **점진적 공개** | 핵심만 메인 파일에, 상세는 참조 파일로 분리 |
15+
| **보편적 적용** | 모든 세션에 필요한 정보만 포함 |
16+
17+
## 문서 유형별 가이드
18+
19+
| 문서 | 권장 길이 | 용도 |
20+
|------|----------|------|
21+
| CLAUDE.md | 60-200줄 | 프로젝트 전역 설정, 컨벤션 |
22+
| SKILL.md | 500줄 이하 | 특화 워크플로우, 도구 사용법 |
23+
| references/ | 무제한 | 상세 API 문서, 스키마 등 |
24+
25+
**지침 개수 한계**: 150-200개 (Claude Code 자체 ~50개 사용)
26+
27+
## 구조 템플릿
28+
29+
### CLAUDE.md
30+
31+
```markdown
32+
# 프로젝트명
33+
34+
## 개요
35+
프로젝트 목적 (1-2문장)
36+
37+
## 기술 스택
38+
- 프레임워크: X
39+
- 언어: Y
40+
- DB: Z
41+
42+
## 명령어
43+
| 명령 | 설명 |
44+
|------|------|
45+
| `yarn dev` | 개발 서버 |
46+
| `yarn test` | 테스트 실행 |
47+
48+
## 컨벤션
49+
- 파일명: kebab-case
50+
- 함수: const 화살표 함수
51+
- 타입: interface (객체), type (유니온)
52+
53+
## 워크플로우
54+
기능 추가 → 테스트 → 린트 → 커밋
55+
```
56+
57+
### SKILL.md
58+
59+
```markdown
60+
---
61+
name: skill-name
62+
description: 무엇을 하는지 + 언제 사용하는지. (scope)
63+
---
64+
65+
# Skill Name
66+
67+
스킬 목적 (2-3문장)
68+
69+
## 사용 시점
70+
- 조건 1
71+
- 조건 2
72+
73+
## 사용 방법
74+
75+
### 기본 워크플로우
76+
1. 단계 1
77+
2. 단계 2
78+
79+
### 참조
80+
- 상세 API: [references/api.md](references/api.md)
81+
- 스키마: [references/schema.md](references/schema.md)
82+
```
83+
84+
## Progressive Disclosure
85+
86+
```
87+
project/
88+
├── CLAUDE.md # 핵심만 (60-200줄)
89+
├── docs/
90+
│ ├── api.md # API 상세
91+
│ └── architecture.md # 아키텍처
92+
└── .claude/skills/
93+
└── my-skill/
94+
├── SKILL.md # 개요 (<500줄)
95+
└── references/ # 상세 정보
96+
```
97+
98+
**토큰 로드 단계:**
99+
100+
| 단계 | 내용 | 크기 |
101+
|------|------|------|
102+
| 1. 메타데이터 | name + description | 30-50 토큰 |
103+
| 2. 활성화 | SKILL.md 본문 | <5k 단어 |
104+
| 3. 참조 | 번들 리소스 | 필요 시만 |
105+
106+
## 작성 규칙
107+
108+
### DO
109+
110+
- 불릿 포인트 + 짧은 문장
111+
- 코드 예시 중심
112+
- 표로 정보 구조화
113+
- 강조: `IMPORTANT:`, `YOU MUST:`
114+
- 1단계 깊이 참조 (A→B ✅, A→B→C ❌)
115+
116+
### DON'T
117+
118+
- 긴 서술형 문단
119+
- Claude가 아는 것 설명
120+
- 린터 역할 강요 (도구 사용)
121+
- 시간 의존적 정보
122+
- /init 자동 생성 의존
123+
124+
## Description 작성
125+
126+
SKILL.md의 description은 스킬 발견에 핵심.
127+
128+
```yaml
129+
# Good - 구체적 + 트리거 포함
130+
description: PDF에서 텍스트/표 추출, 폼 작성. PDF 작업 시 사용.
131+
132+
# Bad - 모호함
133+
description: 문서 처리
134+
```
135+
136+
**규칙:**
137+
- 3인칭 작성 (시스템 프롬프트에 주입됨)
138+
- 무엇을 하는지 + 언제 사용하는지
139+
- 구체적 키워드 포함
140+
141+
## Context 관리
142+
143+
| 명령어 | 용도 | 시점 |
144+
|--------|------|------|
145+
| `/compact` | 컨텍스트 요약 | 70% 도달 |
146+
| `/clear` | 세션 초기화 | 새 기능 시작 |
147+
| `/resume` | 세션 복원 | 작업 재개 |
148+
149+
**주의:** 마지막 20%는 복잡한 작업 피할 것
150+
151+
## Subagent 활용
152+
153+
문서 작성 시 subagent를 적극 활용하여 메인 컨텍스트 보호.
154+
155+
### Subagent 종류
156+
157+
| 타입 | 용도 | 문서 작성 활용 |
158+
|------|------|---------------|
159+
| `Explore` | 코드베이스 탐색 | 프로젝트 구조 파악, 패턴 분석 |
160+
| `Plan` | 구현 계획 수립 | 문서 구조 설계, 섹션 계획 |
161+
| `general-purpose` | 범용 조사 | 베스트 프랙티스 조사, 예시 수집 |
162+
163+
### 활용 시점
164+
165+
**CLAUDE.md 작성 시:**
166+
```
167+
1. Explore agent → 프로젝트 구조/기술 스택 파악
168+
2. Explore agent → 기존 컨벤션/패턴 분석
169+
3. 메인 에이전트 → 요약 기반 문서 작성
170+
```
171+
172+
**SKILL.md 작성 시:**
173+
```
174+
1. Explore agent → 관련 코드/워크플로우 분석
175+
2. Plan agent → 스킬 구조 설계
176+
3. 메인 에이전트 → 설계 기반 작성
177+
```
178+
179+
### 효과
180+
181+
| 방식 | 컨텍스트 사용 |
182+
|------|--------------|
183+
| 직접 탐색 | 전체 파일 내용 로드 |
184+
| Subagent | 요약만 반환 → 90%+ 절약 |
185+
186+
### 프롬프트 예시
187+
188+
```
189+
Explore agent에게:
190+
"프로젝트 구조와 기술 스택을 분석하고,
191+
CLAUDE.md에 포함할 핵심 정보만 요약해줘.
192+
- 디렉토리 구조
193+
- 주요 의존성
194+
- 빌드/테스트 명령어
195+
- 코드 컨벤션"
196+
```
197+
198+
```
199+
Plan agent에게:
200+
"이 스킬의 SKILL.md 구조를 설계해줘.
201+
- 스킬 목적
202+
- 주요 섹션
203+
- 참조 파일 분리 계획
204+
- 워크플로우 단계"
205+
```
206+
207+
## 체크리스트
208+
209+
### CLAUDE.md
210+
211+
- [ ] 60-200줄 이내
212+
- [ ] 기술 스택 명시
213+
- [ ] 주요 명령어 포함
214+
- [ ] 컨벤션 정리
215+
- [ ] 민감 정보 제외
216+
217+
### SKILL.md
218+
219+
- [ ] 500줄 이하
220+
- [ ] description 구체적 (무엇 + 언제)
221+
- [ ] 3인칭 작성
222+
- [ ] 참조 1단계 깊이
223+
- [ ] 100줄+ 파일은 목차 포함
224+
- [ ] 워크플로우에 체크리스트
225+
226+
### 공통
227+
228+
- [ ] 간결한 작성
229+
- [ ] 코드 예시 포함
230+
- [ ] 표로 구조화
231+
- [ ] 시간 의존 정보 없음
232+
- [ ] Subagent로 사전 조사 완료
233+
- [ ] 테스트 완료
234+
235+
## 참조
236+
237+
- [Claude Code Best Practices](https://www.anthropic.com/engineering/claude-code-best-practices)
238+
- [Using CLAUDE.MD files](https://claude.com/blog/using-claude-md-files)
239+
- [Skill Best Practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices)

0 commit comments

Comments
 (0)