Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.6 KB

STYLE.md

File metadata and controls

47 lines (32 loc) · 2.6 KB

글쓰기 규칙

1. 추상어 대신 구체적인 문장

✗ 추상적 ○ 구체적
독자가 바뀌었다 코드를 읽는 독자가 바뀌었다
이름이 중요하다 AI는 함수 이름을 보고 동작을 짐작한다
검증이 필요하다 코드를 한 줄도 안 읽고 맞는지 확인하는 방법
추상화의 비용 함수를 한 번 건너뛸 때마다 AI가 한 번 틀린다

장 제목, 절 제목, 문단 첫 문장은 전부 오른쪽처럼 쓴다. 누가, 무엇을, 어떻게가 들어가야 한다.

2. 비유

  • 비유는 운전 비유(엔진, 계기판, 경고등, 내비, 진단기)를 쓴다.
  • 주방 비유는 쓰지 않는다 (Vibe Coding이 이미 쓰는 비유다).

3. 예제는 코드와 프롬프트 둘 다

  • AI는 코드만 읽는 게 아니라 프롬프트, 지시서, 규칙 파일도 읽는다. 프롬프트도 AI가 읽는 코드다.
  • 예제는 "사람을 위한 버전 → AI를 위한 버전" 순서로 나란히 둔다.
  • 프롬프트 예제에는 AI가 실제로 한 행동(어떤 파일을 열었는지, 무엇을 고쳤는지)을 같이 보여 준다.
  • 코드 예제 언어는 파이썬 기본. 필요하면 타입스크립트.

4. 클린 코드를 대하는 태도

  • 이름을 부를 때는 존중한다. "그 책이 사람 독자를 위한 기준을 세웠다."
  • 반박해도 된다. 지금의 AI는 사람이 쓴 코드로 배웠으므로 클린 코드도 AI가 읽기 좋다. 하지만 AI에게 더 효과적이고 효율적인 방식으로 정리해 가면 클린 코드가 아닌 다른 모양이 나온다. 이 책은 그것을 더티 코드라고 부른다.
  • 같은 결론이면 그대로 차용하고 출처를 밝힌다.

5. 근거

  • 실험 결과는 날짜, 모델 이름, 반복 횟수를 같이 적는다. 모델이 바뀌면 숫자도 바뀐다는 걸 독자가 알게 한다.
  • 외부 사실(책, 연구, 사례)은 출처를 기록해 두고, 본문에 쓰기 전에 원문과 대조한다.
  • 확인하지 못한 것은 확인하지 못했다고 쓴다.

6. 용어

  • 처음 나오는 용어는 그 자리에서 한 줄로 푼다. 예: "컨텍스트 창(AI가 한 번에 볼 수 있는 글의 양)".
  • 영어 약어는 한국어 뜻을 먼저 쓰고 괄호에 약어.

7. 영어가 먼저다

  • 원고는 영어로 먼저 쓴다 (manuscript/en). 영어판이 정본이다.
  • 한국어판은 번역이 아니라 한국어 독자에 맞춰 다시 쓴다 (manuscript/ko). 한쪽 독자에게만 통하는 장면은 바꾼다.
  • 금액은 영어판에서 센트 단위 정수, 한국어판에서 원 단위 정수로 쓴다.