25

README.md - 프로젝트의 얼굴을 만들어라

Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라

학습 목표

채용 담당자가 README를 보는 순서를 이해한다 제조 AI 프로젝트에 최적화된 README 구조를 파악한다 GitHub 배지와 시각 요소 활용법을 익힌다

채용 담당자의 눈으로 보는 README

GitHub 링크를 받은 채용 담당자. 이 사람이 프로젝트를 평가하는 데 걸리는 시간: 30초.

에디터 로딩 중...

제조 AI 프로젝트 README 구조

일반 프로젝트와 다른 점이 있다. 제조 도메인은 문제 정의가 핵심이다.

필수 섹션 (10개)

순서섹션핵심 질문분량
1프로젝트명 + 배지신뢰할 수 있는 프로젝트인가?2줄
2한 줄 소개이게 뭔가?1줄
3문제 정의 만들었는가?3-5줄
4스크린샷/데모실제로 동작하는가?이미지
5주요 기능뭘 할 수 있는가?3-5개
6아키텍처어떻게 만들었는가?다이어그램
7기술 스택어떤 기술을 썼는가?
8설치 방법어떻게 실행하는가?5-10줄
9사용 예시어떻게 쓰는가?코드 블록
10성과 지표얼마나 잘 동작하는가?

문제 정의가 특히 중요한 이유

일반 프로젝트의 소개:

에디터 로딩 중...

제조 AI 프로젝트의 소개:

에디터 로딩 중...

차이가 느껴지는가? 숫자가 있다. 문제가 구체적이다. 솔루션이 명확하다.


GitHub 배지 활용

에디터 로딩 중...

배지는 "이 프로젝트는 관리되고 있다"는 신호다.


기술 스택 표 작성법

에디터 로딩 중...

핵심 정리

  1. README는 30초 안에 승부를 본다
  2. 제조 AI는 **문제 정의(Why)**가 차별화 포인트다
  3. 배지와 표로 시각적 신뢰감을 준다
  4. 숫자가 있으면 설득력이 10배 올라간다