From 17cd0e34b437bf02075eb4c4291e34c035df0c80 Mon Sep 17 00:00:00 2001 From: Claude-51124 Date: Sat, 6 Dec 2025 18:04:09 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EA=B5=AC=EC=A1=B0=ED=99=94=EB=90=9C=20?= =?UTF-8?q?=EC=A0=95=EB=B3=B4=20=ED=98=95=EC=8B=9D=20=EC=9B=90=EC=B9=99=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 표, 파일명:줄번호, 명확한 키워드 사용 권장 - JSON/XML 같은 기계적 형식 금지 명시 - AI와 사람 모두 읽기 좋은 구조화 원칙 추가 --- book/300_architecture/312_문서_작성_원칙.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/book/300_architecture/312_문서_작성_원칙.md b/book/300_architecture/312_문서_작성_원칙.md index 125c980..0ff2dec 100644 --- a/book/300_architecture/312_문서_작성_원칙.md +++ b/book/300_architecture/312_문서_작성_원칙.md @@ -68,6 +68,18 @@ - 관련 정보는 링크로 참조 (중복 작성 금지) - **같은 내용인 경우 새로운 파일 생성하지 말고 기존 파일 수정하여 깔끔하게 정리** +### 구조화된 정보 형식 (AI/사람 모두 읽기 좋게) + +**권장 형식**: +- **표**: 비교, 목록, 역할 구분 등 구조화된 정보 표현 +- **파일명:줄번호**: 코드 위치 명확히 참조 +- **명확한 키워드**: 검색 가능하도록 핵심 단어 명시 +- **목록/부제목**: 정보 계층 구조화 + +**금지 형식**: +- JSON/XML 같은 기계적 형식 (사람이 읽기 어려움) +- 암호화된 코드나 해시값 직접 노출 + ### 절대 금지 사항 | 금지 | 이유 |