50분
제조 AI README.md 작성 실습
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
제조 AI README.md 작성 실습
발표 & 포트폴리오 > Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
학습 목표
제조 AI 프로젝트의 전문적인 README.md를 작성한다 문제 정의에 정량적 수치를 포함한다 GitHub 배지와 아키텍처 다이어그램을 추가한다
미션: 30초 안에 채용 담당자를 사로잡는 README
상황
9주간 만든 제조 AI 트러블슈팅 시스템. 이제 GitHub에 공개한다. 채용 담당자가 이 레포를 보고 30초 안에 "면접 보자"고 해야 한다.
요구사항
- 프로젝트 제목 + 배지 (5개 이상)
- 한 줄 소개 (임팩트 있게)
- 문제 정의 (숫자 포함 3개 이상)
- 주요 기능 (5개, 각각 한 줄 설명)
- 아키텍처 다이어그램 (ASCII Art)
- 기술 스택 표 (8개 이상)
- Quick Start (5단계 이내)
- 성과 지표 (정량적 수치 3개 이상)
- 프로젝트 구조 (디렉토리 트리)
평가 기준
- 30초 안에 프로젝트의 가치를 이해할 수 있는가?
- 문제 정의에 구체적인 숫자가 있는가?
- 복사-붙여넣기로 설치할 수 있는가?
에디터 로딩 중...
정답 보기
에디터 로딩 중...
AI로 학습하기 — 꿀팁
✅README 정량 수치 완결성 검증AI 학습 팁
AI에게 작성한 제조 AI README의 문제 정의 섹션에 정량적 수치(불량률, 다운타임 등)가 빠진 주장을 모두 찾아달라고 요청하세요.
이 제조 AI 프로젝트 README.md를 검토해줘. 문제 정의와 성과 섹션에서 정량적 수치 없이 '개선됐다', '줄었다'처럼 애매하게 서술된 모든 문장을 찾고, 각각에 어떤 종류의 수치(불량률 %, 다운타임 시간, 비용 절감액 등)를 넣어야 하는지 구체적으로 제안해줘.
이 팁이 도움이 됐나요?