convention-documentation

What problem does it solve?

문서 작성 중 일관성 없는 스타일과 구조로 인한 혼란을 줄이고, 팀 간 협업의 품질과 생산성을 향상시킨다.

Core Features & Use Cases

• 마크다운 스타일 규칙: 파일 간 일관된 제목, 코드 블록, 목록 규칙을 제공한다.
• 문서 템플릿 제공: README, 기술 문서, API 문서의 표준 템플릿을 제시한다.
• 가이드 예시: 프로젝트 유형별 문서 구조를 예시로 보여줘 팀이 빠르게 시작할 수 있게 한다.
• Use Case: 신규 프로젝트에서 문서 템플릿과 컨벤션을 한 번에 적용하여 품질을 확보한다.

Quick Start

프로젝트의 문서 템플릿에 이 규칙을 즉시 적용해 보라