repo-docs — 저장소 이해용 문서 생성기
실제 동작 하나를 근거와 함께 추적해, 사람이 읽고 이해할 수 있는 저장소 가이드(repo-docs)를 만들고 유지합니다.
개발·코딩중급★ 461⑂ 6AI 점수 10/10마지막 업데이트: 2026. 7. 12.
무엇을 해주나
- 파일 트리 나열이 아니라 실제 동작 하나(요청·작업·데이터 흐름·실패 경로) 를 끝까지 따라가는 워크스루를 먼저 작성합니다.
README.md,walkthroughs/one-real-run.md,code-map.md,modules/,references/source-evidence.md,glossary.md,change-log.md로 구성된 문서 패키지를 규칙에 따라 생성합니다(소규모 저장소는 Lite, 코드가 아직 없으면 Seed 모드).- 모든 서술을 소스·테스트·설정·명령 검증 후 작성하도록 요구하고, 근거를
Claim | Evidence | Confidence | Caveat표로 남깁니다. - 코드가 바뀐 뒤에는 '동기화 게이트'로
none / answer-only / foreground patch / background sync중 하나를 먼저 결정해 불필요한 문서 수정을 막습니다. - 마지막에 동봉된
scripts/validate_repo_docs.py로 구조·링크·근거·최신성 검증을 수행합니다.
이런 분께 추천
- 신규 입사자 온보딩 문서가 필요한 팀 리드·시니어 개발자
- 오래된 저장소를 인수인계받아 구조부터 파악해야 하는 개발자
- 대형 모노레포에서 특정 서브시스템만 범위로 잡아 설명 문서를 만들고 싶은 분
- 코드 변경 후 문서가 계속 낡아가는 문제를 겪는 프로젝트
활용 예시
- "이 저장소 처음 봐. repo-docs 만들어줘" → 엔트리포인트/테스트/설정을 2회 순회 조사한 뒤 대표 동작 하나를 골라 워크스루와 코드맵을 생성.
- "결제 API 리팩터링했어, 문서 동기화해줘" → 동기화 게이트 판정 후 해당 모듈 페이지만 최소 수정하고
change-log.md에Synced through <sha>기록. - "아직 코드는 없고 기획만 있어" → Seed 모드로
Confirmed / Planned / Unknown라벨을 붙인 프로젝트 메모리 문서 생성. - "생성된 repo-docs 지워줘" → 문서 패키지와 루트 AGENTS.md 라우팅 블록까지 정리.
· · · 설치 가이드 · · ·
설치 없이 지금 한 번 써보기
아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.
이 파일의 지시를 읽고 그대로 따라서 나를 도와줘: https://raw.githubusercontent.com/YurunChen/repo-docs-skills/HEAD/skills/repo-docs/SKILL.md 내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)
Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.
↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.
Claude 앱에 설치 (터미널 필요 없음)
- 아래 버튼으로 ZIP 파일을 받으세요.
- Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
- Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
Claude Code에 설치
Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요
클로드스킬마트에서 찾은 스킬을 설치해줘. GitHub 저장소 YurunChen/repo-docs-skills 의 skills/repo-docs 폴더를 내 ~/.claude/skills/yurunchen-repo-docs/ 에 그대로 복사해줘. 설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.
직접 명령으로 설치하기
git clone https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-skills && mkdir -p ~/.claude/skills && cp -r /tmp/repo-docs-skills/skills/repo-docs ~/.claude/skills/⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.
- 터미널을 엽니다.
- 저장소를 내려받습니다:
git clone https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-skills - 스킬 폴더를 만듭니다:
mkdir -p ~/.claude/skills - 스킬을 복사합니다:
cp -r /tmp/repo-docs-skills/skills/repo-docs ~/.claude/skills/(중국어판이 필요하면skills/repo-docs-zh도 함께 복사) python3 --version으로 파이썬이 있는지 확인합니다(검증 스크립트 실행용).- Claude Code를 재시작하고 대상 프로젝트 폴더에서 "repo-docs로 이 저장소 문서 만들어줘" 라고 요청합니다.
- 작업이 끝나면
repo-docs/README.md부터 읽어보고, 검증 결과 메시지를 확인합니다.