[독서 기록] 개발자를 위한 글쓰기 가이드(유영경 지음, 로드북)

 

 

 

기술 문서의 특징

• 특정 독자를 대상으로 특정 목적을 갖고 특정 정보를 전달
• 어떤 작업을 수행하거나 어떤 주제를 쉽게 이해할 수 있도록 정확한 정보만을 전달

 - 15 p 

 

 

제목에 요점을 담는다. 

- 62p 

 

 

문장 하나에는 주제를 하나만 쓴다.

- 65p 

 

 

예문 : A 서버보다 B 서버에서 파일을 로딩하는 속도가 훨씬 빨랐다.

수정안: 파일을 로딩할 때 A 서버를 사용하면 1.5초, B 서버를 사용하면 0.9초가 걸렸다.

- 68p

 

객관적인 수치나 근거를 제시해야 글의 신뢰도가 높아집니다.

- 69p 

 

 

예문: 화면 상단 우측 위에 위치해 이는 x 버튼을 클릭하면 창이 닫히는 것을 확인할 수 이습니다.

수정: 화면 오른쪽 위에 있는 x 버튼을 클릭하면 창이 닫힙니다.

- 83p 

 

 

대명사는 일반 명사로 바꾼다.

예문: 더 많은 API 사용법을 보려면 여기를 참고하시기 바랍니다.

수정안: 좀 더 많은 API 사용법은 API 레퍼런스를 참고하시기 바랍니다.

- 135p 

 

 

 

단정적인 어조로 확신 있게 쓴다.

예문: 열기를 클릭하면 새 창이 열리게 됩니다.

수정안: 열기를 클릭하면 새 창이 열립니다.

- 142p 

 

 

글꼬리를 뚜렷하게 쓴다.

예문: 앞에서 설명한 문제 해결 방법이 유일한 방법이라고 말할 수는 없지 않을까 싶다.

수정안: 앞에서 설명한 문제 해결 방법이 유일한 것은 아니다.

- 145p 

 

 

군더더기 표현을 없앤다: '발생, '필요', '진행', '처리'

- 153~154p 

 

 

'통해'는 명확한 표현으로 바꾼다.

예문: 이번 테스트에서 나타난 문제점 파악을 통해 부족한 기능을 보완하면 판매가 늘 것이다.

수정안: 이번 테스트에서 나타난 문제점을 파악해 부족한 기능을 보완하면 판매가 늘 것이다.

- 167p 

 

'무엇은 ~ 무엇이다' 형식으로 쓰지 않는다.

- 170p 

 

'~해주다' 대신 '~하다'를 쓴다.

예문: Google 계정으로 로그인을 사용하려면 다음과 같이 구현해 주어야 합니다.

수정안: Google 계정으로 로그인을 사용하려면 다음과 같이 구현해야 합니다.

- 172p 

 

 

 

자주 틀리는 맞춤법

잘못된 표현	올바른 표현
최대값 설정	최댓값 설정
최소값 설정	최솟값 설정
결과값 설정	결괏값 설정
임계값 설정	임곗값 설정
목표값 설정	목푯값 설정
사용율을 높일 수 있다.	사용률을 높일 수 있다.
생산률을 높일 수 있다.	생산율을 높일 수 있다.
갯수를 입력하세요.	개수를 입력하세요.
로그인 시도 횟수를 설정하세요.	로그인 시도 횟수를 설정하세요.
옵션을 키세요.	옵션을 켜세요.
문제를 맞춘 분께 쿠폰을 드립니다.	문제를 맞힌 분께 쿠폰을 드립니다.
화면을 잠궜습니다.	화면을 잠갔습니다.
앱 안의 채팅 기능으로 친구를 사겨 보세요.	앱안의 채팅 기능으로 친구를 사귀어 보세요.
화살표가 가르키는 곳을 터치하세요.	화살표가 가리키는 곳을 터치하세요.
쿠폰을 2개 적용하면 안되요.	쿠폰을 2개 적용하면 안 돼요.
업데이트를 하지 않으려면 아니오를 누릅니다.	업데이트를 하지 않으려면 아니요를 누릅니다.

 

- 187p 

 

 

자주 틀리는 외래어 표기법 

원문	잘못된 표현	올바른 표현
application	어플리케이션	애플리케이션
directory	디렉토리	디렉터리
app	어플	앱
locale	로케일	로캘
shell	쉘	셸
license	라이센스	라이선스
release	릴리즈	릴리스
parameter	파라메터	파라미터
thumbnail	썸네일	섬네일
badge	뱃지	배지
solution	솔루션	설루션
push	푸쉬	푸시
cash	캐쉬	캐시
flash	플래쉬	플래
column	컬럼	칼럼
block	블락	블록
conference	컨퍼런스	콘퍼런스
contents	컨텐츠	콘텐
navigation	네비게이션	내비게이션
mapping	맵핑	매핑
windows	윈도우	윈도
snapshot	스냅샷	스냅숏
manual	메뉴얼	매뉴얼
emulator	애뮬레이터	에뮬레이터
alias	알리아스, 앨리어스	에일리어스
data	데이타	데이터
architecture	아키텍쳐	아키텍처
provision	프로비젼	프로비전
business	비지니스	비즈니스
presentation	프리젠테이션	프레젠테이션
access	억세스	엑세스
drop	드랍	드롭
trend	트랜드	트렌드
elevator	엘레베이터	엘리베이터
repository	레포지터리	리포지터리
message	메세지	메시지
manifest	매니패스트	매니페스트

-189~190p 

 

 

 

자주 틀리는 띄어쓰기

- 파일을 저장 합니다. -> 파일을 저장합니다.

- 신규 서비스 입니다. -> 신규 서비스입니다.

- 비밀번호가 설정 된 파일입니다. -> 비밀번호가 설정된 파일입니다. 

- 나는 예전에 개발을 못한다는 생각을 못했다. -> 나는 예전에 개발을 못한다는 생각을 못 했다.

- 나는 개발을 잘한다는 생각을 잘한다. -> 나는 개발을 잘한다는 생각을 잘 한다. 

- 192~193p

 

잘못된 표현	올바른 표현
해결 방법을 찾아 보겠습니다.	해결 방법을 찾아보겠습니다.
다른 예를 살펴 보겠습니다.	다른 예를 살펴보겠습니다.
정답을 알아 보자.	정답을 알아보자.
10월 출시에는 문제 없습니다.	10월 출시에는 문제없습니다.
날짜 별로 정리	날짜별로 정리
일인 당 비용	일인당 비용
날짜 순으로 정리	날짜순으로 정리
파일을 저장 한다.	파일을 저장한다.
새로 나온 서비스 입니다.	새로 나온 서비스입니다.
메일이 전송 되었습니다.	메일이 전송되었습니다.
사용중에는 선택할 수 없습니다.	사용 중에는 선택할 수 없습니다.
부재 중에는 메모를 남겨 주세요.	부재중에는 메모를 남겨 주세요.
숫자만 입력하면 안됩니다.	숫자만 입력하면 안 됩니다.
쉽게 파일을 주고 받을 수 있습니다.	쉽게 파일을 주고받을 수 있습니다.
한번 더 입력해주세요.	한 번 더 입력해주세요.
새로 나온 앱을 한 번 사용해보세요.	새로 나온 앱을 한번 사용해보세요.
다시 한 번 시도해 주세요.	다시 한번 시도해 주세요.
옵션 설정과는 상관 없다.	옵션 설정과는 상관없다.
나길동님, 반갑습니다.	나길동 님, 반갑습니다.
지난 달, 지난 주	지난달, 지난주
이번달, 이번주	이번 달, 이번 주
다음달, 다음주	다음 달, 다음 주

- 194~195p