생소한 코드베이스 설명은(는) 무엇을 하나요?
목표: 신규 개발자에게 신뢰할 수 있는 맵을 파일 참조와 함께 몇 페이지 분량으로 제공합니다. 모든 주장은 직접 읽은 파일을 가리켜야 합니다.
다음 순서로 탐색하세요
- 목적 및 사용자: README, 패키지 설명, 문서 인덱스. 이 프로젝트는 어떤 문제를 해결하며 누구를 위한 것인가?
- 실행 방법: 메니페스트, Makefile 및 CI 구성에서 설치, 실행, 테스트 명령을 확인합니다. 가벼운 명령(테스트, 린트)을 실행하여 작동 여부를 확인하고, 실행하지 않은 명령은 명시합니다.
- 구조: 디렉터리 트리를 두 단계 깊이까지 확인합니다(
node_modules, 빌드 출력물,.git은 무시). 언어, 프레임워크, 모노레포 구조를 기록합니다. - 진입점:
main, 서버 시작 파일, CLI 진입점, 라우트 정의, 스케줄된 작업, 이벤트 핸들러,bin및scripts항목. - 하나의 실제 흐름을 처음부터 끝까지 추적: 가장 중앙에 있는 요청, 명령 또는 이벤트를 선택하여 진입부터 저장 또는 출력까지 각 파일과 함수 순서대로 따라갑니다.
- 데이터: 스키마, 모델, 마이그레이션, 설정 파일, 코드가 읽는 환경 변수(이름만, 값은 절대 안 됨).
- 외부 접점: 데이터베이스, 큐, 서드파티 API, 인증 제공자.
- 품질 신호: 테스트 위치와 범위, CI 검사, 린트 규칙, TODO가 있는 영역, 매우 큰 파일, 최근 변경 사항(
git log --since="3 months ago" --name-only --pretty=format: | sort | uniq -c | sort -rn | head).
출력
# <저장소> 한 페이지 요약
목적: ...
실행 방법: <명령어, 확인 여부 포함>
맵: <디렉터리 -> 책임, 각 한 줄>
하나의 흐름, 단계별: <파일:함수 ...>
데이터 및 설정: ...
외부 서비스: ...
읽기 시작할 곳: <파일 3개, 이유와 함께>
위험하거나 혼란스러운 영역: <파일, 이유>
열린 질문: <확인할 수 없었던 사항>
규칙
- 각 주장에 대해
경로:라인또는 최소한경로를 인용하세요. 추론한 내용은 "추론됨"이라고 표시하세요. - 열어보지 않은 코드를 설명하지 마세요. 비즈니스 맥락을 추측하지 말고 열린 질문에 기록하세요.
.env파일이나 설정에서 비밀 값을 절대 출력하지 말고 변수 이름만 나열하세요.- 간결하게 유지하세요: 모든 파일을 설명하는 투어가 아닌 맵이어야 합니다.