| name | cs-sync |
| description | CS-GUIDE.md 업데이트 시 기존 CS 문서들을 새로운 가이드에 맞춰 동기화합니다. "CS 동기화", "CS 싱크", "가이드 반영" 요청 시 사용하세요. |
CS 문서 동기화 도우미
CS-GUIDE.md가 업데이트되면 기존에 작성한 CS 문서들을 새로운 가이드 형식에 맞춰 동기화하는 Skill입니다.
트리거 키워드
- "CS 동기화" / "CS 싱크"
- "가이드 반영"
- "CS 문서 업데이트"
- "템플릿 동기화"
- "{카테고리} 동기화" (예: "DB 동기화", "Network 동기화")
동기화 대상
필수 섹션 체크
CS-GUIDE.md 템플릿에 정의된 필수 섹션이 각 문서에 있는지 확인:
| 섹션 | 필수 여부 | 체크 방법 |
|---|---|---|
| 난이도 표기 | 필수 | > \[N]` 형식 존재 여부 |
| 한 줄 정의 | 필수 | 제목 아래 > 인용구 존재 |
| 왜 알아야 하는가? | 필수 | ## 왜 알아야 하는가? 섹션 |
| 핵심 개념 | 필수 | ## 핵심 개념 섹션 |
| 쉽게 이해하기 | 필수 | ## 쉽게 이해하기 섹션 |
| 상세 설명 | 필수 | ## 상세 설명 섹션 |
| 면접 예상 질문 | 필수 | ## 면접 예상 질문 섹션 |
| 연관 문서 | 필수 | ## 연관 문서 섹션 |
| 참고 자료 | 필수 | ## 참고 자료 섹션 |
| 트러블슈팅 | 권장 | ## 트러블슈팅 섹션 (실무 주제인 경우) |
| 트레이드오프 | 권장 | ## 트레이드오프 섹션 (비교 주제인 경우) |
| 예제 코드 | 권장 | ## 예제 코드 섹션 (구현 주제인 경우) |
작업 절차
1단계: 현황 분석
# 전체 CS 문서 목록 확인
find cs/ -name "*.md" -not -name "README.md" -not -name "CS-GUIDE.md"
각 문서에 대해:
- 필수 섹션 존재 여부 체크
- 섹션 순서 확인
- 난이도 표기 형식 확인
- 연관 문서 링크 유효성 확인
2단계: 동기화 우선순위 결정
AskUserQuestion 도구로 동기화 범위 확인:
CS 문서 동기화 범위를 선택해주세요:
1. 전체 동기화 - 모든 CS 문서 업데이트
2. 카테고리별 - 특정 카테고리만 선택
3. 누락 섹션만 - 필수 섹션이 없는 문서만
4. 새 섹션 추가만 - 트러블슈팅 등 새로 추가된 섹션만
3단계: 동기화 실행
누락 섹션 추가
필수 섹션이 없는 경우 템플릿에 맞게 추가:
## {누락된 섹션명}
{TODO: 내용 작성 필요}
섹션 순서 정렬
CS-GUIDE.md 템플릿 순서대로 재정렬:
- 제목 (H1)
- 난이도 표기
- 한 줄 정의
- 왜 알아야 하는가?
- 핵심 개념
- 쉽게 이해하기
- 상세 설명
- 동작 원리 (해당 시)
- 예제 코드 (해당 시)
- 트레이드오프 (해당 시)
- 트러블슈팅 (해당 시)
- 면접 예상 질문
- 연관 문서
- 참고 자료
형식 통일
| 항목 | 기존 형식 | 새 형식 |
|---|---|---|
| 난이도 | 난이도: 중급 |
> \[3] 중급` · 선수 지식: 문서` |
| 면접 질문 | - Q: 질문 |
### Q: 질문\n\nA: 답변 |
| 트레이드오프 | 텍스트 나열 | 표 형식 |
4단계: 검증
동기화 후 체크:
- 모든 필수 섹션 존재
- 섹션 순서 올바름
- 난이도 표기 형식 통일
- 연관 문서 링크 유효
- README.md 목차와 일치
5단계: 결과 보고
동기화 완료 후 보고서 출력:
## CS 문서 동기화 결과
### 전체 현황
- 총 문서 수: {N}개
- 동기화 완료: {N}개
- 수동 작업 필요: {N}개
### 카테고리별 상세
#### db/ (N개)
| 문서 | 상태 | 변경 사항 |
|------|------|----------|
| redis-caching.md | 완료 | 트러블슈팅 섹션 추가됨 |
| jpa.md | 수동 필요 | 연관 문서 링크 누락 |
#### network/ (N개)
...
### 수동 작업 필요 목록
1. `cs/db/jpa.md` - 연관 문서 섹션 내용 작성 필요
2. `cs/os/process.md` - 트러블슈팅 사례 추가 권장
동기화 규칙
자동 동기화 (안전)
다음 항목은 자동으로 수정:
| 항목 | 동작 |
|---|---|
| 누락 섹션 추가 | {TODO} 마커와 함께 빈 섹션 추가 |
| 섹션 순서 정렬 | 템플릿 순서대로 재정렬 |
| 난이도 형식 변환 | 기존 형식 → 새 형식 자동 변환 |
수동 확인 필요
다음 항목은 사용자 확인 후 수정:
| 항목 | 이유 |
|---|---|
| 내용 수정 | 기존 내용 손실 방지 |
| 섹션 삭제 | 의도적 생략일 수 있음 |
| 링크 변경 | 연관 관계 판단 필요 |
트러블슈팅 섹션 추가 기준
실무 관련 주제에만 트러블슈팅 섹션 추가를 권장:
| 카테고리 | 트러블슈팅 권장 주제 |
|---|---|
| db/ | 인덱스, 트랜잭션, 캐싱, 커넥션 풀 |
| network/ | HTTP, TLS, 타임아웃, DNS |
| system-design/ | 캐싱, 로드밸런싱, 메시지 큐 |
| language/ | JVM, GC, 메모리, 동시성 |
다음 주제는 트러블슈팅보다 이론 중심:
| 카테고리 | 이론 중심 주제 |
|---|---|
| algorithm/ | 정렬, 탐색, DP, 그래프 |
| data-structure/ | 배열, 리스트, 트리, 해시 |
| programming/ | SOLID, 디자인 패턴, OOP |
사용 예시
전체 동기화
사용자: CS 동기화
Claude:
1. 전체 CS 문서 스캔 (32개)
2. 누락 섹션 분석
3. 동기화 범위 질문
4. 선택에 따라 동기화 실행
5. 결과 보고서 출력
특정 카테고리 동기화
사용자: DB 동기화
Claude:
1. cs/db/ 문서만 스캔 (8개)
2. 각 문서별 누락 섹션 확인
3. 동기화 실행
4. 결과 보고
새 섹션만 추가
사용자: 트러블슈팅 섹션 추가
Claude:
1. 트러블슈팅 권장 주제 문서 필터링
2. 해당 문서에 트러블슈팅 섹션 템플릿 추가
3. {TODO} 마커로 내용 작성 필요 표시
주의사항
- 백업 우선: 대량 수정 전 git status 확인
- 점진적 수정: 한 번에 모든 문서 수정보다 카테고리별 진행 권장
- 내용 보존: 기존 내용은 최대한 유지, 형식만 수정
- 수동 검토: 자동 동기화 후 반드시 수동 검토
관련 파일
cs/CS-GUIDE.md- 마스터 가이드 (동기화 기준).claude/skills/cs-guide-writer/SKILL.md- 문서 작성 스킬