▶️25분

[영상] 개발자도 글을 잘 써야 한다고요?!

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

학습 목표

기술 문서가 코드만큼 중요한 이유를 설명할 수 있다 README, 아키텍처 다이어그램, Decision Log 각각의 역할을 구분할 수 있다 독자를 고려한 기술 문서 구조를 설계할 수 있다 제조 AI 프로젝트에 적합한 문서 계층을 구성할 수 있다

플레이어 로딩 중...
핵심 포인트
  • • README는 '왜 만들었나 + 어떻게 쓰나'를 30초 안에 전달해야 한다
  • • 아키텍처 다이어그램은 하나의 질문에 하나의 답만 담는다
  • • Decision Log는 '무엇을 결정했나'보다 '왜 그것을 골랐나'가 핵심이다
  • • Mermaid 같은 텍스트 기반 도구를 쓰면 다이어그램도 코드 리뷰 대상이 된다
다음