콘텐츠 작성 가이드
목적
프로젝트 소개 문서의 톤과 밀도를 맞추기 위한 기본 규칙입니다. 링크 모음보다 설명 문서에 가깝게 유지하는 것을 목표로 합니다.
권장 섹션
- 한 줄 소개
- 문제/목적
- 주요 기능
- 기술 스택
- 링크
- 회고 또는 다음 계획
작성 기준
- 첫 문단에서 이 프로젝트가 왜 필요한지 설명합니다.
- 기능 목록만 나열하지 말고, 어떤 판단이 있었는지 한 문장 이상 남깁니다.
- 저장소 링크와 실제 배포 주소는 최신 상태로 유지합니다.
- 관련 운영 문서가 있으면
Archive문서와 교차 링크를 겁니다.
나중에 자동화할 수 있는 항목
- frontmatter 누락 검사
- 프로젝트 카드 목록 자동 생성
- 공개용 문서 템플릿 생성 스크립트