40차시. 발표와 정리

3. 문서화 체크리스트

출처: 원본 PDF 40차시_발표와정리.pdf 6쪽 · 쪽 그림 6쪽

항목	필수	왜 필요한가
무엇을 하는 시스템인가	필수	첫 3줄로 이해되어야 합니다
성능 수치 (측정 방법포함)	필수	"잘 됩니다"와 구별됩니다
구조도	필수	글보다 그림이 빠릅니다
설치·실행 방법	필수	남이 돌려볼 수 있어야 합니다
주요 설정과 근거	필수	왜 그 값인지 설명됩니다
알려진 한계	필수	정직함이 신뢰를 만듭니다
다음에 할 것	권장	계속 발전시킬 의지를 보여줍니다

⚠️ "알려진 한계"를 빼지 마세요
한계를 안 쓰면
· 읽는 사람이 직접 발견합니다
· "이것도 모르나?"가 됩니다
한계를 쓰면
· "이미 알고 있고 대안도 안다"가 됩니다
· 오히려 깊이 있어 보입니다
모르는 것을 모른다고 하는 시스템을 만들었으니,
만든 사람도 그래야 합니다.

3-1) 제출물 목록

출력

my_rag_project/
├── README.md              ← 오늘 작성
├── requirements.txt       ← pip freeze > requirements.txt
├── .env.example           ← 키는 빼고 형식만
├── config.py              ← 근거 주석 포함
├── nodes/ routers.py graph.py app.py
├── data/
│   ├── eval_set.json      ← 평가셋 전체
│   ├── eval_dev.json
│   └── eval_holdout.json
├── eval/                  ← 평가 코드
└── docs/
    ├── requirements.md    ← 38차시 요구사항
    ├── architecture.png   ← 구조도
    └── eval_report.md     ← 평가 리포트