41 lines
2.9 KiB
Markdown
41 lines
2.9 KiB
Markdown
# rules/prose-style — 한국어 작성 원칙 (윤문은 외부 하네스로 이관)
|
|
|
|
> `rules/` 의 방법론 규칙입니다.
|
|
> **2026-07-21 변경:** 한국어 문체·자연스러움 검사와 윤문 책임을 이 저장소에서 **제거**하고 별도 하네스 [im-not-ai](https://github.com/) (`/humanize-korean`) 로 이관했습니다.
|
|
> 이 문서에는 llm-wiki 가 계속 책임지는 두 가지 — **한국어로 쓴다**는 원칙과 **사실 경계** — 만 남깁니다.
|
|
|
|
## 왜 이관했나
|
|
|
|
문서를 쓰는 도중에 문장 단위로 윤문을 검사하면, 문서 한 편에 시간이 과도하게 들고 검사 지점이 잘게 쪼개져 실패 지점만 늘어납니다. 윤문은 본래 **문서를 다 쓴 뒤 한 번에 훑는 작업**이고, 그걸 전문으로 하는 하네스가 이미 있습니다.
|
|
|
|
- llm-wiki 의 책임: 구조·계약·근거·의미 정합 (`quality_gate`, `typed_contract_check`, semantic certificate)
|
|
- im-not-ai 의 책임: 한국어 자연스러움, AI 티 제거, 번역투 교정
|
|
|
|
## 1. 작성 원칙 (llm-wiki 책임)
|
|
|
|
- **본문은 한국어로 씁니다.** 영어 단어를 습관적으로 섞지 않습니다.
|
|
- **개발·기술 용어는 원문(주로 영어)을 유지합니다.** 예: `connection pool`, `idempotent`, `latency`, `circuit breaker`, `transaction`. 억지로 한글화하지 않습니다.
|
|
- 코드, CLI 명령어, 설정 키, 에러 메시지, 계약 ID(`FE-OC-001`, `DEC-...@1`)는 그대로 인용합니다.
|
|
- 표현이 다소 어색해도 **작성 단계에서는 넘어갑니다.** 문체 교정은 아래 §3 의 마무리 단계에서 일괄 처리합니다.
|
|
|
|
## 2. 사실 경계 (llm-wiki 책임 — 이관 대상 아님)
|
|
|
|
윤문은 표현만 다듬고 **사실 등급을 바꾸지 않습니다.** `documented-only` · `planned` · `needs-confirmation` 을 매끄러운 문장으로 포장해 검증된 것처럼 보이게 하면 안 됩니다(CLAUDE.md §6, §11). 과장 표현(`최적화했다`, `X배 개선`, `운영 중`)은 근거 등급이 받쳐줄 때만 씁니다.
|
|
|
|
- `POLISHED_OVERCLAIM` — 윤문으로 미검증 사실을 검증된 것처럼 포장. **이관 후에도 llm-wiki 가 검사합니다.**
|
|
|
|
im-not-ai 로 윤문을 돌린 뒤에도 이 경계는 다시 확인해야 합니다. 자연스러움을 높이는 과정에서 단정 표현이 강해질 수 있기 때문입니다.
|
|
|
|
## 3. 윤문 실행 (im-not-ai)
|
|
|
|
문서 작성이 끝난 뒤, 개별 문서가 아니라 **작업 묶음 단위로 한 번** 실행합니다.
|
|
|
|
```text
|
|
경로: /home/donghyeon/workspace/ai-tool/im-not-ai
|
|
호출: /humanize-korean (Claude) · $humanize-korean (Codex)
|
|
```
|
|
|
|
- 대상: 파생 산출물(`40-publish/` interview · blog · portfolio)과 사람이 읽을 문서.
|
|
- 설계 문서(`10-projects/` project-note · branch-note)는 AI 가 읽는 용도이므로 **필수 아님** — 용어가 뒤섞여 읽기 힘들 때만 돌립니다.
|
|
- 실행 후 §2 사실 경계를 재확인합니다.
|