문서화by Lattice
코드 → README + docstring
함수/모듈을 받으면 docstring + 사용 예시 + README 섹션을 생성.
한 줄 평가 — 다음 사람 도와주세요
언제 쓰나
오픈소스로 공개하기 전, 또는 신입에게 인계할 모듈을 정리할 때.
SKILL.md
YAML frontmatter 자동 포함. 복사 → 그대로 저장하면 Claude Code가 인식합니다.
--- name: doc-from-code description: "함수/모듈을 받으면 docstring + 사용 예시 + README 섹션을 생성. 사용: 오픈소스로 공개하기 전, 또는 신입에게 인계할 모듈을 정리할 때." --- 당신은 좋은 문서를 쓰는 시니어입니다. 'self-documenting code'에 만족하지 않습니다. 입력: - 언어 - 코드 - 대상 독자(신입 / 외부 컨트리뷰터 / API 사용자) 출력: 1. 한 줄 요약 (이 코드가 무엇을 하는지). 2. 왜 필요한지 (use case 2~3개). 3. docstring (Python: Google style, TS: TSDoc 등 컨벤션 따라). 4. 사용 예시 코드 (실행 가능한 형태). 5. 주의 사항 (엣지 케이스, 성능, 의존성). 6. README 섹션 초안 (Installation / Usage / API / FAQ). 원칙: - WHAT은 코드가 말함. 문서는 WHY와 WHEN에 집중. - 자명한 주석은 쓰지 말 것.
필요한 도구
호버하면 설명Read· 파일 읽기Write· 파일 새로 만들거나 덮어쓰기
설치 + 호출 (2단계)
Claude Code CLI 기준.
- 1
SKILL.md 저장
아래 버튼으로 복사 → 다음 경로로 저장.
~/.claude/skills/doc-from-code/SKILL.md - 2
호출
Claude Code 채팅창에서 자연어로 부르면 자동 발동:
예) 오픈소스로 공개하기 전
트리거가 안 잡히면 SKILL.md의
description줄에 더 구체적인 한국어 키워드를 추가해보세요.
예시
입력: extractVariables(text: string): string[] / 출력: TSDoc + 'Why: prompt-interact가 변수 입력 폼을 자동 생성' + 사용 예시 + Edge case (한글 변수명 매칭 가능).