15

기술 문서화 이해도 점검

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

학습 목표

기술 문서화의 핵심 원칙을 점검한다 README, API 문서, 아키텍처 문서의 차이를 구분한다

6문제

Q1. README에서 채용 담당자가 가장 먼저 보는 것은?

Q2. 제조 AI 프로젝트 README에서 일반 프로젝트와 가장 다른 점은?

Q3. FastAPI에서 API 문서가 자동 생성되는 핵심 요소는?

Q4. 아키텍처 문서에서 C4 모델의 L2(Container)에 해당하는 것은?

Q5. 도메인 지식 문서에서 반드시 기록해야 할 것은?

Q6. 운영 매뉴얼의 장애 대응 런북이 빛나는 순간은?