코드베이스 스냅샷 매퍼 (레포 스캔 → 모듈 맵 → 30분 온보딩 브리프)
어떤 GitHub 레포지토리든 진입점, 모듈, 주요 의존성, 학습 우선순위를 포함한 1페이지 아키텍처 맵으로 빠르게 전환하여 신속한 온보딩을 지원합니다.
프롬프트 개요
추천 팁
- VS Code의 경로 복사 기능으로 다듬은 파일 트리를 붙여넣으세요. - package.json 또는 pyproject.toml을 포함해 스크립트와 도구를 추론하세요. - 진입 흐름 정확도를 높이기 위해 샘플 엔드포인트나 명령어 하나를 추가하세요.
운영팀 제공NexusAi Technology해결하는 문제
새로운 기여자들은 실행 시작 지점, 모듈 간 관계, 중요한 파일을 파악하는 데 수시간을 허비합니다. 이 프롬프트는 명확한 맵과 시작용 브리프를 만들어 자신 있게 탐색할 수 있도록 돕습니다.
빠른 진입점 탐지
앱 부팅 방식과 실행 시작 위치를 식별합니다.
모듈 책임 맵
주요 폴더와 역할을 한 페이지로 요약합니다.
의존성 인사이트
중요 라이브러리와 그 중요성을 드러냅니다.
시간 제한 온보딩 계획
30분, 5단계 스타터 계획을 제공합니다.
AI 프롬프트 지침
경험 많은 소프트웨어 아키텍트이자 온보딩 멘토 역할을 수행하세요.
이 작업이 중요한 이유:
새로운 기여자들은 진입점, 핵심 모듈, 규칙을 찾느라 시간을 낭비합니다. 명확한 스냅샷은 첫 커밋까지의 시간을 단축하고 실수를 줄입니다.
중요한 경계:
- 코드를 임의로 생성하지 말고, 제공된 트리, README, 선택된 파일을 기반으로 인사이트를 도출하세요.
- 불확실한 부분은 명확히 표시하고, 증거가 불충분할 경우 다음에 검사할 파일 목록을 제시하세요.
사용자 입력:
- 레포지토리 이름, 목적, 주요 언어/프레임워크.
- 주요 파일: README, package/lock 파일, 메인 앱/서버 진입점, 라우팅 설정, 모듈 폴더, 테스트.
- 상위 목표(예: 온보딩, 버그 분류, 기능 추가).
목표:
1) 주요 진입점과 실행 흐름 파악.
2) 주요 모듈, 역할, 데이터 흐름 개요 작성.
3) 의존성, 설정, 스크립트, 공통 유틸리티 강조.
4) 복잡도 집중 구역과 즉각적인 학습 우선순위 표시.
분석 작업 흐름:
1) README를 파싱해 프로젝트 목표, 설정, 실행 명령어 확인.
2) 의존성 파일을 검사해 빌드, 실행, 테스트 파이프라인 추론.
3) 진입점(예: main.ts, index.js, app.py)과 라우팅 매핑.
4) 파일을 기능 영역별로 그룹화하고 각 영역을 한 문장으로 요약.
5) 교차 관심사(인증, 로깅, 오류 처리, 상태 관리) 기록.
6) 읽어야 할 상위 5개 파일/폴더 순서 지정.
필수 출력 형식:
- 한 문단 개요.
- 아키텍처 맵: 모듈 → 역할 → 주요 파일의 글머리표 목록.
- 진입점 및 요청/CLI 흐름 요약.
- 주요 의존성과 그 중요성.
- 복잡도 집중 구역 및 위험 노트.
- 30분 온보딩 계획 (5단계, 시간 제한).
품질 관리:
- 정확한 파일명과 경로 사용.
- 사실과 추정을 구분하고, 추정은 명확히 표시.
검증 체크리스트:
- 진입점 확인.
- 최소 5개 모듈 또는 폴더 매핑.
- 실행/테스트 명령어 수집.
- 학습 우선순위 순위화.
최종 지침:
신규 개발자가 첫 30분 동안 참고할 수 있는 간결하고 쉽게 훑어볼 수 있는 1페이지 브리프를 작성하세요.
예상 결과
개요: Node.js + Express를 사용한 작업 관리용 웹 API. 아키텍처 맵: - server/: Express 앱 부트스트랩 (server/index.js) - routes/: HTTP 엔드포인트 (routes/tasks.js) - controllers/: 요청 조율 (controllers/taskController.js) - models/: Sequelize를 통한 데이터 접근 (models/task.js) - middleware/: 인증/로깅 (middleware/auth.js) 진입 흐름: npm run start → server/index.js → routes → controllers → models. 주요 의존성: express, sequelize, jsonwebtoken. 복잡도 집중 구역: 인증 미들웨어 복잡성, tasks 컨트롤러 크기. 30분 계획: 1) README 훑기 (3분) 2) server/index.js 열기 (5분) 3) GET /tasks 추적 (7분) 4) 인증 미들웨어 검토 (7분) 5) 테스트 실행 (8분).
실행 과정
ChatGPT에서 스냅샷 생성하기
ChatGPT를 열고 레포지토리 README, 다듬은 파일 트리, 주요 파일(진입점, 라우팅, 설정)을 붙여넣으세요. 이 프롬프트를 사용해 1페이지 아키텍처 맵과 30분 온보딩 계획을 요청하세요. 모듈 목록, 진입 흐름, 주요 학습 우선순위를 기대할 수 있습니다.
10 minVS Code에서 레포지토리와 대조 검증하기
VS Code에서 레포지토리를 열고 나열된 각 파일/경로로 이동해 역할을 확인하세요. 구조가 다르면 모듈 이름을 조정하세요. 문서화된 시작/테스트 스크립트를 실행해 진입점과 테스트 커버리지를 검증하세요.
10 min팀 온보딩 노트로 게시하기
스냅샷, 파일 링크, 30분 계획을 포함한 짧은 문서를 지식 베이스나 레포 위키에 작성하세요. 신규 기여자를 위해 레포 README에 고정하세요.
10 min
