From 0198e8370443d9e743e6d76320d6d2492ed8ac1b Mon Sep 17 00:00:00 2001 From: Claude-51124 Date: Sat, 3 Jan 2026 12:43:20 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EB=AC=B8=EC=84=9C=20=EC=9E=91=EC=84=B1?= =?UTF-8?q?=20=EC=9B=90=EC=B9=99=20=EA=B5=AC=EC=A1=B0=20=EC=B5=9C=EC=A0=81?= =?UTF-8?q?=ED=99=94=20=EB=B0=8F=20=EC=A4=91=EB=B3=B5=20=EC=A0=9C=EA=B1=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 섹션 8(문서화 흐름)의 문서 역할 설명을 섹션 1 참조로 간소화 - 문서 유형 명칭 통일 (계획 문서, 트러블슈팅 문서 등) - 서비스 README 및 인덱스 README 정의를 핵심 위주로 압축 --- .../312_문서_작성_원칙.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/book/300_architecture/312_문서_작성_원칙.md b/book/300_architecture/312_문서_작성_원칙.md index 1f52350..5a54e2c 100644 --- a/book/300_architecture/312_문서_작성_원칙.md +++ b/book/300_architecture/312_문서_작성_원칙.md @@ -273,21 +273,19 @@ - 사용자 경험 관점에서 기능 정의 - "어떤 기능을 만들지" 먼저 정의 -2. **`journey/plans/`**: 구현 계획 작성 (만들기 전) - - 아키텍처/Phase/필요작업만 +2. **계획 문서** (`journey/plans/`): 구현 계획 작성 (만들기 전) + - 아키텍처/Phase/필요작업만 기록 (섹션 1 참조) - 구현 완료 시 `plans/archive/`로 이동하고 troubleshooting 문서와 링크 연결 -3. **`journey/troubleshooting/`**: 구현 과정 기록 (만들면서/만든 후) - - 문제 해결, 교훈, 테스트 결과 +3. **트러블슈팅 문서** (`journey/troubleshooting/`): 구현 과정 기록 (만들면서/만든 후) + - 문제 해결, 교훈, 테스트 결과 기록 (섹션 1 참조) - 크기 제한 및 초과 시 처리: 섹션 4 참조 -4. **서비스 README.md**: 핵심 사항 업데이트 (만든 후) - - 엔드포인트, 환경변수, 사용 방법 - - 자주 변하는 구체적 정보 +4. **서비스 README.md**: 서비스별 핵심 사항 업데이트 (만든 후) + - 엔드포인트, 환경변수, 사용 방법 등 구체적 정보 기록 -5. **인덱스 README.md** (journey/research/, journey/ideas/ 등): 인덱스 역할만 - - 문서 목록과 간단한 설명, 상세는 링크로 참조 - - 중복 작성 금지 (troubleshooting 내용 재작성 금지) +5. **인덱스 README.md**: 폴더별 문서 인덱스 업데이트 (만든 후) + - 문서 목록과 간단한 설명 기록 (섹션 1 참조) 6. **`book/`**: 원칙 변경 시 업데이트 (필요시) - 아키텍처 원칙이 바뀌면 반영