영어 기술 문서 읽기
영어 문서를 읽을 때의 어려움
섹션 제목: “영어 문서를 읽을 때의 어려움”비원어민 개발자가 영어 기술 문서를 읽을 때 흔한 문제:
- 전체 단락을 이해하지 못해 문장별로 번역해야 함
- 낯선 표현을 만나면 단어를 찾아야 해서 워크플로우가 중단됨
- 다 읽고 나서 잊어버리거나, 표현 방식을 기억하지만 사용법을 모름
- 문서의 좋은 예문을 배울 수 없음 (저장할 곳이 없음)
세 가지 워크플로우
섹션 제목: “세 가지 워크플로우”워크플로우 1: 빠른 단어 찾기 (작업 중단 없이)
섹션 제목: “워크플로우 1: 빠른 단어 찾기 (작업 중단 없이)”문서를 읽다가 낯선 구문을 만났지만, 빠르게 이해하되 중단하고 싶지 않을 때.
Reading: "This design pattern leverages polymorphismto achieve decoupling between layers."
만남: "leverages" — 빠른 단어 찾기작업:
- “leverages” 선택
- ⌘⇧D (전역 단축키)
- DevGlish 플로팅 창이 나타나며 정의와 발음 표시
- 한번 읽고 닫기 (⌘W)
- 문서 계속 읽기
워크플로우 2: 단락 모드 (깊이 있는 이해)
섹션 제목: “워크플로우 2: 단락 모드 (깊이 있는 이해)”전체 단락을 이해하지 못하고 문장별 분해가 필요할 때.
예시: Python 문서의 설명
Original paragraph:"The descriptor protocol is a beautiful piece of Python thatallows you to define what happens when an attribute is accessed,modified, or deleted. This is achieved through special methods__get__, __set__, and __delete__, which must be defined ondescriptor objects."작업:
- 전체 단락 복사
- DevGlish 단락 모드 열기 (메뉴 → Paragraph Mode)
- 텍스트 붙여넣기
- Claude의 문장별 분해 보기
워크플로우 3: 좋은 표현 저장 (라이브러리 축적)
섹션 제목: “워크플로우 3: 좋은 표현 저장 (라이브러리 축적)”문서를 읽으면서 좋은 표현 방식을 발견했습니다. 저장해 두면 나중에 코드 리뷰나 문서에서 활용할 수 있습니다.
예시:
Kubernetes 문서를 읽을 때:
"A controller watches the shared state of the cluster through the APIserver and makes changes attempting to move the current state towardsthe desired state."이 문장의 표현이 매우 전문적이어서 이 방식을 배우고 싶습니다.
작업:
- 이 문장 선택
- ⌘⇧D로 DevGlish 열기
- “저장” 버튼 클릭
- “technical-writing”과 “kubernetes” 태그 지정
나중에 PR이나 기술 문서를 작성할 때 이 태그를 검색하여 표현을 재사용하거나 개작할 수 있습니다.
문서 읽기 모범 사례
섹션 제목: “문서 읽기 모범 사례”1. 먼저 이해하고 나서 코드를 깊이 봅니다
섹션 제목: “1. 먼저 이해하고 나서 코드를 깊이 봅니다”복잡한 개념을 만났을 때:
- 단락 모드로 문서 설명 이해
- 개념을 읽은 후 코드 예시 보기
- 여전히 불명확하면 YouTube 강의 검색
2. 활성 어휘 라이브러리 (Active Vocabulary)
섹션 제목: “2. 활성 어휘 라이브러리 (Active Vocabulary)”표현을 만났을 때 세 가지 선택지:
| 처리 방식 | 시나리오 | 예시 |
|---|---|---|
| 빠른 단어 찾기 (저장 안 함) | 이해만 하면 됨, 단기간 사용 안 함 | ”parameterize” (매개변수화) |
| 저장하되 복습 안 함 | 좋은 표현, 나중에 사용 가능 | ”achieves decoupling” (디커플링 달성) |
| 저장 + 복습 | 자주 사용, 능동적으로 익혀야 함 | ”race condition” (레이스 컨디션) |
3. 문서 유형에 따른 전략 조정
섹션 제목: “3. 문서 유형에 따른 전략 조정”| 문서 유형 | 읽기 방법 | 언제 저장 |
|---|---|---|
| API 문서 | 빠르게 훑기, 낯선 단어 찾기 | 매개변수 설명, 일반적 용법 |
| 튜토리얼 | 단락 모드로 문장별 이해 | 좋은 설명 문장, 예문 |
| 설계 문서 | 개념에 집중, 세부사항 무시 | 아키텍처 설명, 설계 트레이드오프 설명 |
| 블로그 글 | 전체 단락 읽기, 모호한 부분에 단락 모드 사용 | 관점 표현, 모범 사례 표현 |
단계적 읽기 난이도 향상
섹션 제목: “단계적 읽기 난이도 향상”1단계: 쉬운 문서 (입문)
섹션 제목: “1단계: 쉬운 문서 (입문)”- Django 초보자 튜토리얼
- 공식 API 입문 가이드
- 중간 난이도 블로그 글
전략: 빠른 단어 찾기 + 가끔 단락 모드
저장률: 5~10%의 새 표현
2단계: 중간 난이도 문서
섹션 제목: “2단계: 중간 난이도 문서”- Kubernetes 공식 문서
- 대규모 오픈소스 프로젝트의 설계 문서
- 고품질 기술 블로그
전략: 단락 모드로 복잡한 문장 처리, 단락 모드로 낯선 개념 처리
저장률: 15~20%의 새 표현
3단계: 고난이도 문서
섹션 제목: “3단계: 고난이도 문서”- 학술 논문 (본인 분야 관련)
- 복잡한 RFC (Request For Comments)
- 깊이 있는 기술 분석
전략: 먼저 한국어 요약이나 강의 동영상을 보고 원문을 읽으며, 단락 모드로 각 단락 처리
저장률: 20~30%의 새 표현 (모두 고가치)
빠른 참조: 세 가지 버튼
섹션 제목: “빠른 참조: 세 가지 버튼”| 버튼 | 동작 | 시나리오 |
|---|---|---|
| 빠른 단어 찾기 (⌘⇧D) | 단어 선택 → 빠른 플로팅 창 → 정의 보기 → 닫기 | 빠르게 이해하고 계속 읽기 |
| 단락 모드 | 단락 복사 → 붙여넣기 → 문장별 분해 받기 | 전체 단락을 모르거나 깊이 이해하고 싶을 때 |
| 저장 | 표현 선택 → 단어 찾기 시 저장 클릭 | 좋은 표현, 나중에 복습하거나 사용 |
문서 읽기의 시간 투자
섹션 제목: “문서 읽기의 시간 투자”기술 문서를 읽을 때 시간 배분:
- 50% — 주요 개념 이해 (빠른 단어 찾기, 단락 모드)
- 30% — 코드 예시 읽기, 따라 하기
- 20% — 좋은 표현 저장, 단어장에 추가
하나의 표현에 너무 많은 시간을 쓰지 마세요. “80% 정도면” 계속 진행하고, 100% 완벽한 이해를 추구하지 마세요.