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

docs: 구조화된 정보 형식 원칙 추가

Browse Source 
- 표, 파일명:줄번호, 명확한 키워드 사용 권장
- JSON/XML 같은 기계적 형식 금지 명시
- AI와 사람 모두 읽기 좋은 구조화 원칙 추가
This commit is contained in:
Claude-51124 2025-12-06 18:04:09 +09:00
parent 73f5ffe834
commit 17cd0e34b4
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -68,6 +68,18 @@
- 관련 정보는 링크로 참조 (중복 작성 금지) - 관련 정보는 링크로 참조 (중복 작성 금지)
- **같은 내용인 경우 새로운 파일 생성하지 말고 기존 파일 수정하여 깔끔하게 정리** - **같은 내용인 경우 새로운 파일 생성하지 말고 기존 파일 수정하여 깔끔하게 정리**
### 구조화된 정보 형식 (AI/사람 모두 읽기 좋게)
**권장 형식**:
- **표**: 비교, 목록, 역할 구분 등 구조화된 정보 표현
- **파일명:줄번호**: 코드 위치 명확히 참조
- **명확한 키워드**: 검색 가능하도록 핵심 단어 명시
- **목록/부제목**: 정보 계층 구조화
**금지 형식**:
- JSON/XML 같은 기계적 형식 (사람이 읽기 어려움)
- 암호화된 코드나 해시값 직접 노출
### 절대 금지 사항 ### 절대 금지 사항
| 금지 | 이유 | | 금지 | 이유 |