Skip to content

프로젝트 문서화 방식

프로젝트 문서는 저장소 소개글이 아니라, 누군가가 읽고 프로젝트를 이해할 수 있는 설명 문서여야 합니다.

권장 섹션

  1. 한 줄 소개
  2. 문제/목적
  3. 주요 기능
  4. 기술 스택
  5. 링크
  6. 회고 또는 다음 계획

작성 기준

  • 첫 두 문단 안에 이 프로젝트가 왜 필요한지 보여줍니다.
  • 기능 목록은 3~5개 수준으로 압축합니다.
  • 구현 세부는 나열보다 판단 근거 중심으로 씁니다.
  • 배포 주소와 저장소 링크는 최신 상태를 유지합니다.

Moonworld Docs on Cloudflare Pages