메뉴
코드를 읽고 docs/를 생성·구조화한다. 코드만 있고 문서가 없는 영역에서 프로젝트 맵, 모듈 문서, API 개요, 아키텍처 메모를 만든다.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | code-to-docs |
| description | 코드를 읽고 docs/를 생성·구조화한다. 코드만 있고 문서가 없는 영역에서 프로젝트 맵, 모듈 문서, API 개요, 아키텍처 메모를 만든다. |
| disable-model-invocation | true |
이 skill은 문서가 비어 있는 코드 영역에서 사람 읽기 좋은 문서를 만드는 데 쓴다. 코드 동작을 추정해 단정하지 않는다. 확인 가능한 사실과 추정을 분리한다. 파일 생성/수정 workflow이므로 수동 호출 전용이다.
docs-organize).pdr).docs/project-map.md — 폴더/모듈 트리와 책임docs/build-and-test.md — 빌드/테스트/린트/실행 명령 (package.json, Makefile, build.gradle 등 SSOT 참조)docs/architecture.md — 데이터 흐름, 의존 방향, 외부 시스템 연결docs/modules/<name>.md — 큰 모듈별 책임·공개 인터페이스·확장 포인트docs/api/<area>.md — 외부에 노출되는 API 개요 (실제 스펙은 OpenAPI 등 SSOT 참조)docs/runbook.md — 운영/배포/장애 대응 절차(필요 시)후보를 전부 만들지 않는다. 코드에서 확인 가능한 사실이 있는 것만 만든다.
docs/README.md 라우터에 연결한다.# Project Map
## 루트 구조
- `src/` — <한 줄 설명>
- `tests/` — <한 줄 설명>
- ...
## 모듈
### `<module-name>`
- 위치: `<path>`
- 책임: <한 문장>
- 공개 인터페이스: <export/router/CLI 진입점>
- 주요 의존: <내부 모듈, 외부 라이브러리>
- 관련 문서: <docs 경로>
# <module-name>
## 책임
- <코드에서 보이는 사실>
## 공개 인터페이스
- `<symbol>` (`<path>:L<line>`) — <역할>
## 데이터 모델
- <스키마, 타입>
## 외부 의존
- <서비스, 라이브러리>
## 확장 포인트
- <플러그인, 콜백, 설정>
## 설계 메모 (사용자 확인 후 채움)
- 의도: <추정 또는 사용자 확인 필요>
- 트레이드오프: <추정 또는 사용자 확인 필요>
docs/README.md 라우터에 새 문서가 연결되었는가## code-to-docs 결과
- 스캔 대상: <경로>
- 생성: <문서 목록과 이유>
- 추정으로 분리한 항목: <목록>
- 사용자 확인 필요: <질문>
- 라우터 갱신: docs/README.md
사용자 요청이 모호하거나 작업 전 결정이 필요할 때, 바로 구현하지 않고 파일 수정 없이 scope, 대상, 검증 기준을 1-3개 질문으로 좁혀 묻는다.
기존 docs/와 README, 인접 문서를 읽고 재배치·구조화한다. 라우터 docs/README.md를 정비하고 중복·모순·고아 문서를 정리한다. 새 본문을 만들기보다 기존 문서의 정리가 우선이다.
작업 결과, 수정 파일, 검증 내역, 남은 리스크, 그리고 사용자가 바로 고를 수 있는 다음 액션 후보를 짧게 정리해 인수인계한다.
Product Design Review — 신규 기능/화면/API/모듈을 만들거나 크게 바꾸기 전에 목표·사용자 시나리오·제약·엣지케이스·검증 기준을 짧게 결정해 docs/design-reviews/에 남긴다.
claude-pet 릴리스/배포 전 점검 — gradle.properties 버전 정합성, 3단 빌드 검증(compile → 개발 실행 → 번들), README/docs 동기화, release-please 상태를 확인한다. 트리거 — '릴리스 점검', '배포 전 확인', 'release-check', '릴리스 준비됐는지 봐줘'.
프로젝트 스택과 반복 작업을 분석해 custom skill을 실제로 생성한다. 후보 기록만으로 끝나지 않고 .claude/skills/<name>/SKILL.md를 만든다.