# 📝 문서 작성 스타일 규칙

> 문서(.md) 작성 시 자동 적용되는 품질 기준

## 일반 가이드라인

| 항목 | 기준 |
|------|------|
| 언어 | 한국어 |
| 톤 | 명확, 간결, 전문적이면서 이해하기 쉽게 |
| 이모지 | 제목/부제목/목록에 문맥 관련 이모지 적절 사용. 과도한 사용 지양 |
| 형식 | 마크다운(`.md`) |
| 일관성 | 용어, 스타일, 문서 구조 통일 |

## 내용 작성 규칙

### 정확성
- 제공된 정보/기획 문서 기반으로 **정확한 내용** 작성
- 추측이나 확인되지 않은 정보 금지
- 추상적 설명보다 **구체적 예시, 코드 스니펫, 단계별 지침** 포함

### 인용
- 첨부 파일 내용 참조 시 해당 내용 뒤에 출처 표기

### 링크
- 다른 문서 링크는 정확한 **상대 경로** 사용
- 헤딩 ID 기반 앵커 링크 정확히 작동하도록 작성

### 참조 금지 원칙
- 아직 생성되지 않은 파일 참조 금지
- 모든 필요한 코드는 **문서 내에 완전히 포함**
- "나머지는 X 파일 참조" 같은 표현 금지
- 각 문서는 **독립적으로 완전**해야 함

### 자리 표시자
- 다이어그램, 미확정 사항, 추후 추가 내용은 `[TODO]` 또는 `[PLACEHOLDER]`로 명확 표기

## 분량 가이드라인

| 항목 | 기준 |
|------|------|
| 적정 분량 | 5-7분 읽기 (1,500-2,000 단어) |
| 코드 포함 시 | 최대 3,000줄 이내 |
| 목차 | 스크롤 없이 한 화면에 보이도록 |

## 간결성 원칙

- **핵심 코드 + 간단한 설명**만 포함
- 예제는 대표적인 것 **1-2개**만
- 중복 설명 제거, 한 번만 명확히

## 실행 중심 구성

- "이렇게 하세요" 방식의 **명확한 지시문**
- 복사해서 바로 사용 가능한 **실행 가능한 코드**
- 체크리스트 중심의 검증 가능한 내용

## 구분 명확화

- **[필수]** vs **[선택]** 항목 명확 표시
- 코드 블록에 **파일 경로** 항상 명시
- 환경별 차이는 **조건문**으로 한 번에 표현

## AI 최적화

- 긴 설명보다 **주석이 포함된 코드** 선호
- 복잡한 개념은 **다이어그램**이나 **표**로 요약
- 각 섹션은 **독립적으로 이해 가능**하게 작성

## 상호작용

- 초안 작성 완료 후 사용자 확인 요청
- 사용자 피드백 반영하여 수정
- 답변은 간략하게, 다음 스텝 진행 여부를 물어보는 수준
