신규 입사자용 코드베이스 안내 쓰는 프롬프트
어디부터 읽어야 하는지 순서를 줍니다. 전체를 설명하려 하지 않습니다.
| 분류 | 개발 › 기술 문서 |
|---|---|
| 태그 | 초안작성체크리스트개발자 |
Write a codebase onboarding guide. Structure: 1. **The mental model** — what this system does, in the terms the team uses. Three or four sentences, including the two or three domain words that appear everywhere. 2. **Reading order** — five to eight files or modules, in order, with one line each on why it comes at that point. *Not a directory tour.* Someone who reads these should be able to follow a request end to end. 3. **Trace one path all the way through** — a single common operation from entry to storage to response. This teaches more than any diagram. 4. **Their first task**, broken into steps with which parts of the reading it needs. 5. **Where the surprises are** — the parts that do not work the way the naming suggests, the historical decisions that look wrong, the file everyone is afraid of. *This is the section that only exists in people's heads and is the most valuable thing here.* 6. Look it up when you need it — everything else, as a list, not explained. Rules: - Assume they can program and do not know this system. Do not explain the language. - *Do not attempt completeness.* Say explicitly what this guide leaves out. - Where I did not tell you something, mark it as a question for the team rather than guessing at how the code works. - Name who to ask for what.
붙여 넣으면 맨 아래에 채울 칸(코드베이스 구조 · 첫 과제 · 팀 상황)이 나옵니다
어떤 프롬프트인가
코드베이스 문서는 대개 전체를 설명하려다 아무도 안 읽는다. 이 프롬프트는 첫 주에 필요한 것만 남기고, 나머지는 "필요할 때 찾아볼 것" 목록으로 내린다.
같은 분류의 프롬프트
| FTTH 통신 전문가 역할을 맡기는 프롬프트 | |
| 개발자 아키텍처 안내 프롬프트 | |
| LLM 입문서 작성 프롬프트 | |
| 프로그래밍 팀 구성 프롬프트 | |
| CLAUDE.md 조립 프롬프트 |