ivada-infra/DOCS
3
0
Fork 0
Code Issues 1 Pull Requests 5 Actions Packages Projects Releases Wiki Activity

docs: 문서 작성 원칙 강화 - plan 문서 구현 섹션 즉시 삭제 명시

Browse Source
This commit is contained in:
happybell80 2025-12-04 22:19:16 +09:00
parent ee3644e6b5
commit abd641bdb5
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
book/300_architecture/312_문서_작성_원칙.md
View File

@ -47,12 +47,13 @@
**규칙**: **규칙**:
- **구현 완료 시 `journey/troubleshooting/`으로 이동** (필수) - **구현 완료 시 `journey/troubleshooting/`으로 이동** (필수)
- **구현 완료 섹션은 즉시 삭제** - "→ 상세: troubleshooting/yymmdd_*.md" 링크로만 대체
- **아키텍처/Phase/필요작업만** - 장황한 구현 코드 예시 최소화
- **시나리오/테스트/리포트 별도 파일 금지** - 하나의 파일에 통합 - **시나리오/테스트/리포트 별도 파일 금지** - 하나의 파일에 통합
- 계획 → 구현 → 테스트 → 교훈 순서로 작성
- 100줄 이하 유지 - 100줄 이하 유지
**구분**: **구분**:
- `plans/`: 미구현 (will do) - `plans/`: 미구현 계획만 (will do)
- `troubleshooting/`: 구현 완료 + 문제 해결 (did + learned) - `troubleshooting/`: 구현 완료 + 문제 해결 (did + learned)
--- ---