Work Docs Code Explain

Code Explain

목적

복잡한 코드를 분석하여 누구나 이해할 수 있는 설명으로 변환합니다. 온보딩, 코드 리뷰, 학습에 활용됩니다.

지침

1. 대상 파악

사용자가 지정한 코드 또는 파일을 읽습니다. 설명 대상자가 누구인지 파악합니다:

• 해당 프로젝트에 처음 투입된 개발자
• 코드를 처음 보는 팀원
• 특정 부분만 이해하고 싶은 경우

2. 큰 그림부터 설명

• 목적: 이 코드가 왜 존재하는가
• 입력/출력: 무엇을 받아서 무엇을 반환하는가
• 전체 흐름: 단계별로 무슨 일이 일어나는가

3. 핵심 부분 상세 설명

• 복잡한 알고리즘이나 로직은 단계별로 분해
• 언어/프레임워크 특유의 패턴 설명
• 왜 이렇게 구현했는지 의도 추론

4. 예시로 구체화

실제 입력값과 그에 따른 실행 흐름을 예시로 보여줍니다.

5. 주의할 점

• 기술 용어는 처음 등장할 때 설명
• 코드를 단순히 한국어로 번역하지 않고 의미 설명에 집중

출력 형식

## 코드 설명: `함수명`

### 한 줄 요약
이 함수는 _____ 합니다.

### 전체 흐름
1. 먼저 _____ 를 합니다.
2. 그 다음 _____ 를 확인합니다.
3. 마지막으로 _____ 를 반환합니다.

### 핵심 로직 상세
(복잡한 부분 설명)

### 예시
입력: `{ userId: 1 }`
→ DB에서 id=1인 사용자 조회
→ 출력: `{ name: "Alice", email: "..." }`

### 참고사항
- 주의해야 할 엣지 케이스
- 연관된 다른 함수/모듈

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: JoNaYeon
• Source: JoNaYeon/claude-code-skills
• License: MIT

Install and usage instructions live in the source repository linked above.