update-docs
Skill14 starsChanged 7 months agoMITView on GitHub
오늘(또는 지정 날짜)의 git 커밋을 분석하여 docs/changelog/ 와 SETUP.md 문서를 자동 업데이트합니다. (CLAUDE.md는 기본 대상에서 제외)
- Reads credentials
87 other projects use a version of this.
Adopted by
Most recently taken up by
- rmichak/claude-skillstheir own version, first seen Nov 8, 2026
- Eclipter/agentstheir own version, first seen Nov 8, 2026
- rvdbreemen/OTGW-firmwaretheir own version, first seen Nov 8, 2026
- jmusick/skillstheir own version, first seen Nov 8, 2026
- protokol11/skillstheir own version, first seen Nov 8, 2026
- OldemarJesus/connectlife-mcp-servertheir own version, first seen Nov 8, 2026
Used with
Projects with it also use get-pr-reviews, push-everything and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
saffron-healthSkillget-pr-reviews
Get nicely formatted output of the last review comments on a PR. Used internally by other skills.
Also in 3 projects that use this
saffron-healthSkillpush-everything
Stage ALL changes in the repository (not just session changes), commit, and push. Use when you need to commit all pending changes.
Also in 3 projects that use this
TheKREATORSSkillinstinct-export
Export instincts from project/global scope to a file
Also in 3 projects that use this
TheKREATORSSkillinstinct-import
Import instincts from file or URL into project/global scope
Also in 3 projects that use this
NVIDIASkillgenerate-spec
Produce a feature specification covering API changes, backward compatibility, cross-language impact, performance, and a file-level change plan. Use when designing a new feature, planning a significant change, or the user asks to spec something out.
Also in 3 projects that use this
belokonmSkillfullstack-developer
End-to-end feature expert specializing in frontend-backend integration, system architecture, and complete application development
Also in 4 projects that use this
- +1 more from saffron-health
- +1 more from TheKREATORS
Other versions87 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 87
- vercel/next.js★ 143ksame name
- pipecat-ai/pipecat★ 17ksame name
- anyproto/anytype-ts★ 9.1ksame name
- vladmandic/sdnext★ 7.4ksame name
- ArcReel/ArcReel★ 6.3ksame name
- dotnet/sdk★ 3.2ksame name
- meta-pytorch/OpenEnv★ 2.8ksame name
- huggingface/OpenEnv★ 2.8ksame name
- man-group/ArcticDB★ 2.6ksame name
- fabro-sh/fabro★ 1.8ksame name
77 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository8 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- lessonSkill
- manage-skillsSkill
- merge-worktreeSkill
- releaseSkill
- remove-worktreeSkill
- update-wikiSkill
- verify-implementationSkill
The file
Files
문서 업데이트
목적
특정 날짜(기본: 오늘)의 git 커밋을 분석하여 다음 문서를 일관되게 업데이트합니다:
docs/changelog/YYYY-MM/YYYY-MM-DD.md— 해당 날짜 변경 이력 파일 신규 생성 (또는 같은 날 추가 항목이면-2/-3suffix)docs/changelog/README.md— 인덱스에 한 줄 추가docs/SETUP.md— 사용법/API 테이블 반영
CLAUDE.md는 이 스킬의 기본 업데이트 대상이 아닙니다. 일상적인 기능 추가/수정은 changelog와 SETUP.md만 갱신하고, CLAUDE.md는 손대지 않습니다. CLAUDE.md는 기존 설명에 사실과 다른 부분(실수)이 있다고 명확히 확인된 경우에만 그 부분만 정확히 고치도록 합니다 — 자세한 조건은 "Step 6: CLAUDE.md 처리" 참조.
워크플로우
Step 1: 대상 커밋 수집
인수를 파싱하여 대상 커밋 범위를 결정합니다:
- 인수 없음: 오늘 날짜 (
git log --since="YYYY-MM-DDT00:00:00" --until="YYYY-MM-DDT23:59:59") - 날짜 지정 (예:
2026-04-03): 해당 날짜 커밋 - 커밋 범위 (예:
abc123..def456): 해당 범위 커밋
대상 커밋이 0개이면:
## 문서 업데이트
해당 기간에 커밋이 없습니다.종료합니다.
Step 2: 변경 분석
각 커밋에 대해 다음을 수집합니다:
git log <hash> -1 --format="%B"— 커밋 메시지 전문git diff <hash>^..<hash> --stat— 변경 파일 목록git diff <hash>^..<hash>— 주요 파일의 실제 diff (서버 서비스, DB 스키마, 라우트, 클라이언트 컴포넌트 중심)
수집한 정보를 바탕으로 다음을 파악합니다:
- 기능 추가: 새 파일, 새 API 엔드포인트, 새 UI 컴포넌트
- 아키텍처 변경: 서비스 역할 변경, 새 패턴 도입, DB 스키마 변경
- 사용법 변경: 새 설정 옵션, 새 사용자 기능, UI 흐름 변경
Step 3: 현재 문서 읽기
다음 파일을 읽습니다:
docs/changelog/README.md— 인덱스 형식과 가장 최근 entry의 월/파일명 패턴 파악- 직전 entry 파일 1-2개 (예:
docs/changelog/YYYY-MM/YYYY-MM-DD.md) — 본문 스타일과 톤 파악 docs/SETUP.md— 섹션 번호, API 테이블 위치 파악
CLAUDE.md는 읽지 않습니다. (기본 대상이 아니므로 Step 6에서 실수 정정 조건이 만족될 때만 부분적으로 읽습니다.)
Step 4: 날짜별 changelog 파일 생성 + 인덱스 갱신
4a. 파일 경로 결정
- 대상 날짜가
YYYY-MM-DD이면 폴더는docs/changelog/YYYY-MM/ - 해당 폴더가 없으면 신규 생성
- 파일명:
- 같은 날 첫 번째 항목:
YYYY-MM-DD.md - 같은 날 두 번째 이후 항목 (이미
YYYY-MM-DD.md가 있는 경우): 기존 파일을YYYY-MM-DD-1.md로 rename 후 새 파일을YYYY-MM-DD-2.md로 생성. 이미-1,-2패턴이면 다음 번호로 이어감.
- 같은 날 첫 번째 항목:
4b. 파일 본문 (기존 entry 스타일 그대로)
## YYYY-MM-DD — 한줄 요약 제목
### 배경
왜 이 변경이 필요했는지 1-2문장.
### 주요 변경
#### 1. 기능/변경 이름 (`커밋해시`)
- 변경 내용 bullet points
- **서버**: 서버 측 변경
- **클라이언트**: 클라이언트 측 변경
- **DB**: 스키마 변경
- **i18n**: 번역 키 추가
### 수정된 주요 파일
| 파일 | 변경 내용 |
|------|----------|
| `path/to/file.ts` | 변경 설명 |
### 아키텍처 결정
1. **결정 이름**: 왜 이렇게 했는지4c. 인덱스 갱신 (docs/changelog/README.md)
- 해당 월(
## YYYY-MM) 섹션의 최상단에 한 줄 추가:- [YYYY-MM-DD — 제목](./YYYY-MM/YYYY-MM-DD.md) - 해당 월 섹션이 아직 없으면, 적절한 위치(최신 월이 위에 오도록)에 새
## YYYY-MM헤더와 함께 추가 - 같은 날 항목이 여러 개라 파일이
-1/-2형태면 링크도 그에 맞춰 작성
주의사항:
- 커밋 메시지의 상세 설명이 있으면 그대로 활용
- 같은 날 커밋이라도 주제가 명확히 다르면 별도 entry 파일로 나누기 (예: GitHub 통합 vs Notion 통합)
- 주제가 같으면 한 entry 파일에 묶기
- 기존 entry와 동일한 한국어 톤/스타일 유지
- 파일 끝에 trailing newline 1개 유지 (기존 파일과 동일)
Step 5: SETUP.md 업데이트
변경 내용에 따라 필요한 섹션만 업데이트합니다:
5a. 새 사용자 기능이 추가된 경우
- 적절한 위치에 새 섹션 추가 (번호 순서 유지)
- 뒤따르는 섹션 번호 자동 조정
- 설정 방법, 사용법, 주의사항 포함
5b. 새 API 엔드포인트가 추가된 경우
## API 요약테이블에 새 행 추가- 기존 엔드포인트 그룹 근처에 배치 (예: git 관련은 git 엔드포인트 근처)
5c. 환경 변수가 추가된 경우
## 2단계: 환경 설정섹션의.env예시에 추가
5d. DB 컬럼만 추가되고 사용자 기능이 없는 경우
- SETUP.md는 수정하지 않음
Step 6: CLAUDE.md 처리 (기본은 "건드리지 않음")
기본 동작: CLAUDE.md를 수정하지 않는다. 새 기능 / 새 컴포넌트 / 새 라우트 / 새 DB 컬럼이 추가됐다는 이유만으로 CLAUDE.md를 갱신하지 않습니다. 정상 워크플로에서는 changelog + SETUP.md만으로 변경이 충분히 문서화됩니다.
예외: CLAUDE.md의 기존 설명이 실수(사실 오류)로 확인된 경우에만 그 부분을 정확히 정정합니다. 다음 조건이 모두 충족될 때만 수정합니다:
- 사용자가 명시적으로 "CLAUDE.md를 고쳐"라고 지시했거나, 이번 커밋이 CLAUDE.md의 기존 진술과 직접 모순되는 변경이어야 함 (예: CLAUDE.md에 "X는 항상 Y한다"고 적혀 있는데, 이번 커밋이 그 동작을 바꿈)
- 새 정보를 추가하는 게 아니라 잘못된 기존 정보를 교체하는 작업이어야 함
- 수정 범위는 잘못된 부분에 한정 — 같은 문단에 부가 설명을 끼워 넣거나, 새 컴포넌트 / 새 라우트 / 새 패턴을 그 김에 끼워 넣지 말 것
위 조건이 하나라도 안 맞으면 CLAUDE.md는 손대지 않고 Step 7로 진행합니다. 새 기능 설명은 changelog와 SETUP.md에 충분히 들어 있어야 합니다.
수정하는 경우의 주의사항 (실수 정정이 확정된 후):
- CLAUDE.md는 영어로 작성
- 기존 bullet point 스타일과 상세도 수준 유지
- 잘못된 부분의 단어/구절만 교체. 주변 문장에 부가 설명을 끼워 넣지 말 것
- 불필요한 정보 추가 금지 (예: 커밋 해시, 날짜, 새 기능 홍보 문구)
Step 7: 결과 요약
모든 업데이트 완료 후 요약을 출력합니다. CLAUDE.md를 건드리지 않은 경우 그 행은 표에서 제외합니다 (정상 동작 — 따로 언급할 필요 없음).
## 문서 업데이트 완료
**대상**: YYYY-MM-DD 커밋 N개
| 문서 | 변경 |
|------|------|
| `docs/changelog/YYYY-MM/YYYY-MM-DD.md` | 신규 entry 파일 생성: "제목" |
| `docs/changelog/README.md` | 인덱스에 한 줄 추가 |
| `docs/SETUP.md` | 섹션 X 추가, API 테이블 Y개 행 추가 |CLAUDE.md를 실수 정정 조건에 따라 수정한 경우에만 별도 행을 추가하고 어떤 사실 오류를 어떻게 고쳤는지 한 줄로 기록합니다.
예외사항
다음은 문제가 아닙니다:
- WIP/temp/fixup 커밋 — 이런 커밋은 최종 결과 기준으로 통합하여 문서화 (중간 과정은 무시)
- 문서만 수정한 커밋 — CHANGELOG에 기록하지 않음 (문서 수정은 문서화할 필요 없음)
- 커밋 메시지가 불충분한 경우 — diff를 직접 분석하여 변경 내용 파악
- SETUP.md 섹션 번호 불연속 — 새 섹션 추가 시 뒤따르는 번호를 자동 조정
Related Files
| File | Purpose |
docs/changelog/README.md | 인덱스 (월별 섹션 + 날짜별 entry 링크) |
docs/changelog/YYYY-MM/YYYY-MM-DD.md | 날짜별 entry 본문 |
docs/SETUP.md | 설치/사용법 가이드 (섹션 번호 + API 테이블) |
CLAUDE.md | 프로젝트 아키텍처 설명 (영어). 이 스킬의 기본 업데이트 대상이 아님 — 사실 오류 정정 시에만 부분 수정 |
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

