문서 자동 생성
문서화입문
지정된 코드 파일이나 모듈을 분석하여 함수 시그니처, 파라미터 설명, 반환값, 사용 예시를 포함한 문서를 자동으로 생성합니다.
트리거
/docs [file]사용빈도주 1-2회
문서화가 밀려있는 오픈소스 메인테이너라면? /docs src/utils로 함수 시그니처부터 예시까지 자동 생성
문서자동화가독성
작동 흐름
/docs [파일] 실행
↓
Phase 1: 3개 분석 병렬
sig-parse
시그니처 파싱
type-extract
타입 정보 추출
usage-find
사용 패턴 수집
↓
마크다운 문서 생성
↓
✓ 파라미터 테이블 + 반환값 + 사용 예시
스킬 코드
# Doc Generator Skill
## Trigger: /docs [file or directory]
When invoked:
1. Analyze target code:
- Exported functions/classes
- Parameter types and defaults
- Return types
- Usage patterns in codebase
2. Generate documentation:
- Function signatures with descriptions
- Parameter table with types and defaults
- Return value description
- Usage examples from actual codebase
3. Format:
## functionName(params)
Description of what this function does.
### Parameters
| Name | Type | Default | Description |
|--------|--------|---------|--------------|
| param1 | string | - | What it does |
### Returns
`ReturnType` — Description
### Example
```typescript
const result = functionName("input");
```
복사해서 CLAUDE.md에 붙여넣으면 바로 사용할 수 있습니다.
문서 자동 생성 작동 방식
Doc Generator는 소스 코드 파일을 읽어 함수 시그니처, 클래스 구조, 인라인 코멘트를 추출한 후, 파라미터 설명, 반환 타입, 사용 예시를 포함한 포맷된 API 문서를 생성합니다.
문서 자동 생성이(가) 빛나는 순간
문서 없이 성장한 기존 코드베이스를 문서화해야 할 때 매우 유용합니다. 구현 패턴에서 코드의 의도를 파악하여 API 사용자에게 실질적으로 도움이 되는 문서를 생성합니다.
핵심 특장점
- 코멘트뿐만 아니라 코드 구조에서 문서를 추출
- 실제 함수 시그니처 기반의 사용 예시 생성
- 다양한 출력 형식 지원 (Markdown, JSDoc 등)
- 실행할 때마다 코드 변경과 문서를 동기화