프로젝트 문서화 방식

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

권장 frontmatter

title: 프로젝트 이름
repo: https://github.com/seihwanMoon/your-project
summary: 한 줄 소개
tags:
  - vitepress
status: active
stack:
  - TypeScript
demo: https://docs.moonworld.uk
order: 10

권장 섹션

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

문장을 쓰는 기준

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

좋은 흐름

문제를 먼저 설명하고, 그 다음 기능과 기술 선택으로 내려가는 구조가 읽기 쉽습니다. 이 흐름은 홈이나 가이드보다 프로젝트 문서에서 더 중요합니다.

TIP

프로젝트 문서를 쓰기 전에 콘텐츠 작성 가이드도 함께 확인하는 편이 좋습니다.