English
☰ 분류

저장소 README 쓰는 프롬프트

처음 온 사람이 10분 안에 돌려볼 수 있게 씁니다. 기능 소개보다 실행을 앞에 둡니다.

분류개발 › 기술 문서
태그초안작성템플릿개발자
프롬프트 (영어 본문 · 답은 한국어로 옵니다)
Write a README for this project.

Order, strictly:
1. **One sentence: what this is and who it is for.** Not a tagline.
2. **Quickstart** — the shortest path from clone to something working. Exact commands. *If this takes more than about ten minutes or five commands, say so and say why; that is the finding.*
3. What you should see when it worked.
4. Prerequisites, but only the ones that actually block. Move the rest down.
5. Common failures during setup, with the fix. Every project has two or three and they are almost never written down.
6. Configuration — only what must be set. Defaults stay in a table further down.
7. How to run the tests.
8. Everything else — architecture, contributing, license.

Rules:
- *Commands must be copy-pasteable.* Where a value has to be supplied, say where to obtain it.
- Do not open with badges, a logo, or a feature list. Someone reading this wants it running.
- **Where I did not tell you how something works, write `TODO:` with the specific question** rather than a plausible instruction. A wrong setup step costs more than a missing one.
- State what this project does *not* do, if there is an obvious adjacent thing people will assume.
붙여 넣으면 맨 아래에 채울 칸(프로젝트 설명 · 실행 방법 · 읽는 사람)이 나옵니다

어떤 프롬프트인가

README에서 필요한 건 소개가 아니라 "어떻게 돌리냐"다. 이 프롬프트는 실행까지 가는 최단 경로를 맨 앞에 두고, 막히는 지점을 미리 적는다.

같은 분류의 프롬프트

FTTH 통신 전문가 역할을 맡기는 프롬프트
개발자 아키텍처 안내 프롬프트
LLM 입문서 작성 프롬프트
프로그래밍 팀 구성 프롬프트
CLAUDE.md 조립 프롬프트