🏆45분
데일리 챌린지: 문서 3종 세트 완성
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
데일리 챌린지: 문서 3종 세트 완성
발표 & 포트폴리오 > Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
학습 목표
README.md, API 문서, 아키텍처 문서를 모두 완성한다 각 문서의 독자와 목적에 맞게 내용을 구성한다 문서 간 일관성을 유지한다
요구사항
Day 1 챌린지: 문서 3종 세트
제출물
1. README.md (최종 버전)
- 배지 5개 이상
- 문제 정의 (숫자 포함)
- 아키텍처 다이어그램
- Quick Start (복사-붙여넣기로 실행 가능)
- 성과 지표 표
2. docs/ARCHITECTURE.md
- 컨테이너 구성도
- 데이터 흐름도
- 기술 선택 이유 (ADR) 3개 이상
3. docs/OPERATIONS.md
- 배포 절차 (step-by-step)
- 환경변수 표
- 장애 대응 런북 3개 이상
4. docs/domain/threshold-values.md
- 시스템에서 사용하는 임계값 3개 이상
- 각 임계값의 근거와 출처
평가 기준
- 채용 담당자가 README를 30초 안에 이해할 수 있는가?
- 프론트엔드 개발자가 API 문서만으로 연동할 수 있는가?
- 당직자가 런북만으로 장애를 복구할 수 있는가?
- 후임자가 도메인 문서로 "왜"를 이해할 수 있는가?
평가 기준
- • README 완성도 (배지, 문제 정의, 아키텍처, Quick Start)
- • API 문서 품질 (Pydantic description/example 완성도)
- • 아키텍처 문서 (다이어그램, ADR, 데이터 흐름)
- • 운영 매뉴얼 (배포 절차, 런북, 환경변수)
- • 도메인 지식 문서 (임계값 근거, 출처)
- • 문서 간 일관성 (용어, 구성, 기술 스택 일치)
AI로 학습하기 — 꿀팁
🤖문서 3종 일관성 자동 검토AI 학습 팁
기획서·기술 명세·발표자료 3종이 서로 모순 없이 일관된 메시지를 전달하는지 AI로 교차 검토하세요. 수동으로 놓치기 쉬운 용어 불일치·수치 오류를 한 번에 잡을 수 있습니다.
다음은 내가 작성한 제조 AI 프로젝트 문서 3종입니다.
[기획서 요약]
{여기에 붙여넣기}
[기술 명세 요약]
{여기에 붙여넣기}
[발표자료 슬라이드 요약]
{여기에 붙여넣기}
세 문서 간에 (1) 용어 불일치, (2) KPI·수치 불일치, (3) 스코프·범위 차이가 있는지 표로 정리하고, 각 항목에 수정 권고안을 제시해줘.이 팁이 도움이 됐나요?