Update READMEs

코드베이스 전체에서 README.md 파일을 탐색하고, 각 README가 실제 디렉토리 내용과 일치하는지 검증한 뒤 필요한 부분을 업데이트하는 스킬이다.

Process

Step 1: README.md 파일 탐색

Glob 도구로 **/README.md 패턴을 검색한다. 단, 아래 경로는 반드시 제외한다:

• node_modules/
• .git/
• .next/
• dist/, build/, out/

검색 결과가 없으면 "README.md 파일을 찾을 수 없습니다"라고 알리고 종료한다.

Step 2: 각 README.md 분석 및 업데이트 판단

발견된 각 README.md에 대해 다음을 수행한다:

1. README.md 읽기: Read 도구로 파일 내용을 읽는다
2. 디렉토리 내용 확인: Bash의 ls 명령으로 README.md가 위치한 디렉토리의 실제 하위 항목(파일, 폴더)을 확인한다
3. 불일치 분석: README에 기술된 내용과 실제 디렉토리 구조를 비교하여 다음을 확인한다:
   • README에 언급되었으나 실제로는 존재하지 않는 파일/폴더
   • 실제로 존재하지만 README에 누락된 파일/폴더
   • 설명이 실제 내용과 맞지 않는 항목
   • 링크가 깨진 경로

Step 3: 업데이트 수행

불일치가 발견된 README.md만 수정한다:

• 기존 문서 스타일 유지: 원본 README의 어조, 포맷, 마크다운 스타일을 그대로 따른다
• 최소 변경 원칙: 불일치하는 부분만 수정하고, 정확한 내용은 건드리지 않는다
• Edit 도구 사용: 전체 덮어쓰기가 아닌 Edit 도구로 변경이 필요한 부분만 수정한다
• 내용 유실 금지: 기존 설명이나 가이드 텍스트를 삭제하거나 축약하지 않는다

Step 4: 결과 보고

모든 README.md 처리가 끝나면 결과를 요약 보고한다:

1## README 업데이트 결과
2
3| 파일 | 상태 | 변경 내용 |
4|------|------|-----------|
5| README.md | 업데이트됨 | prototypes/ 섹션에 새 프로젝트 추가 |
6| knowledges/README.md | 변경 없음 | - |
7| ... | ... | ... |

업데이트 판단 기준

다음 경우에 업데이트가 필요하다:

• 디렉토리에 새 하위 폴더/파일이 추가되었으나 README에 반영되지 않은 경우
• README에 언급된 폴더/파일이 삭제되었거나 이름이 변경된 경우
• 폴더 구조 트리(``` 블록)가 실제와 다른 경우
• 링크 경로가 실제 파일 위치와 불일치하는 경우

다음 경우에는 업데이트를 하지 않는다:

• README가 없는 디렉토리에 새로 README를 생성하는 것 (이 스킬의 범위 밖)
• 내용의 정확성 판단이 주관적인 경우 (예: 설명 문구의 적절성)
• node_modules/, .git/ 등 제외 대상 디렉토리의 README

Important Notes

• knowledges/ 디렉토리의 README는 내용을 축약하거나 유실하지 않도록 특히 주의한다
• README에 이모지가 사용된 경우 기존 스타일을 유지한다
• 폴더 구조 트리를 업데이트할 때는 실제 ls 결과를 기반으로 정확하게 작성한다
• 루트 README.md의 Skill 목록 테이블은 CLAUDE.md의 Skills 섹션과 일치시킨다

Example Usage

1/update-readmes

파라미터 없이 실행하면 코드베이스 전체의 README.md를 자동 검사하고 업데이트한다.

Quality Checklist

• node_modules, .git 등 제외 대상이 검색에서 빠졌는가
• 파일명이 정확히 README.md인 파일만 대상으로 했는가
• 실제 디렉토리 구조와 README 내용을 정확히 비교했는가
• 기존 README의 스타일과 어조가 유지되었는가
• 변경이 필요 없는 README는 건드리지 않았는가
• 결과 요약 보고가 제공되었는가