객관적으로 문서를 검토한다
- 소리 내어 읽기
- 시간을 두고 다시 읽기: 24시간이 지난 뒤 다시 읽어본다
- 온라인 문서라면 인쇄해서 읽기
맥락에 맞는 적확한 단어를 선택한다
지난 서비스보다 성능이 훨씬 개발되었습니다.
지난 서비스보다 성능이 훨씬 향상되었습니다.
크기 및 전기 소모가 작습니다.
크기가 작고 전기 소모가 적습니다
은어는 형식적인 표현으로 바꾼다
로그를 까 보고 설정을 다르게 줘 보는 것부터 해 보죠.
로그를 확인해 설정을 바꾸는 것부터 해 보죠.
이벤트에 로직을 태워 알림 창을 띄웠습니다.
이벤트에 로직을 적용해 알림 창이 나타나게 했습니다.
일부 편집기에서 한글이 깨져 보일 수 있습니다.
일부 편집기에서 한글이 제대로 보이지 않을 수 있습니다.
대명사는 일반 명사로 바꾼다
좀 더 많은 API 사용법을 보려면 여기를 참고하시기 바랍니다.
좀 더 많은 API 사용법은 API레퍼런스를 참고하시기 바랍니다.
업무 캘린더를 사용하면 동료와 쉽게 일정을 공유할 수 있습니다. 또한 이를 통해 프로젝트 진척도도 관리할 수 있습니다.
업무 캘린더를 사용하면 동료와 쉽게 일정을 공유할 수 있습니다. 업무 캘린더에서 프로젝트 진척도도 관리할 수 있습니다.
고유한 이름은 정확히 쓴다
AOS, andriod
Android
엑셀, 사파리, 인스타그램, 페이스북
Excel, Safari, Instagram, Facebook
단정적인 어조로 확신 있게 쓴다
열기를 클릭하면 새 창이 열리게 됩니다.
열기를 클릭하면 새 창이 열립니다.
글꼬리를 뚜렷하게 쓴다
앞에서 설명한 문제 해결 방법이 유일한 방법이라고 말할 수는 없지 않을까 싶다.
앞에서 설명한 문제 해결 방법이 유일한 것은 아니다.
KM 클라우드 도입 이유를 다음과 같이 크게 세 가지로 갈라 볼 수 있다.
KM 클라우드를 도입해야 하는 이유는 크게 세 가지다.
문장은 짧게 줄인다
KM 로그 서비스는 사용자의 드라이브 사용 이력을 확인할 수 있는 서비스입니다. 기본적으로 제공이 되는 서비스로, 별도의 서비스 활성화 작업 과정을 거치지 않고도 바로 사용하실 수 있는 서비스입니다.
KM 로그 사용자의 드라이브 사용 이력을 확인할 수 있는 서비스입니다. 기본으로 제공되며, 별도로 활성화하지 않아도 바로 사용하실 수 있습니다.
군더더기 표현을 없앤다
'발생'
인증서 도메인당 월 8만 원의 비용이 발생합니다.
인증서 비용은 도메인당 월 8만 원입니다.
'필요'
서비스 활성화를 진행하기 위해서는 먼저 콘솔 로그인이 필요합니다.
서비스를 활성화하려면 먼저 콘솔에 로그인해야 합니다.
'진행'
원하는 파일 유형을 선택해 다운로드 진행해 주세요.
원하는 파일 유형을 선택해 다운로드해 주세요.
'처리'
사용자 ID 설정 처리 이후에 초기화를 진행하십시오.
사용자 ID를 설정한 후 초기화하십시오.
의미가 같은 표현은 한 번만 쓴다
- 역전 앞
- 가로수 나무
- 철교 다리
- 동해 바다
- 과반수 이상
기존에 이미 저장한 데이터입니다.
이미 저장한 데이터입니다.
결제 수단 등록 시, 카드 정보를 입력하게 되면, 비밀번호를 만들기 위한 질문에 답변을 하게 되면 비밀번호가 생성이 됩니다.
결제 수단을 등록할 때, 비밀번호를 만들려면 카드 정보를 입력하고 비밀번호 만들기용 질문에 답변해야 합니다.
피동태보다 능동태로 쓴다
Python은 귀도 반 로섬에 의해 개발되었습니다.
Python은 귀도 반 로섬이 개발했습니다.
결과 로그가 화면에 보여집니다.
결과 로그가 화면에 나타난다.
아이템 목록에 담겨진 항목입니다.
아이템 목록에 있는 항목입니다.
복잡한 번역체를 다듬는다
'~에 대해'
자바 스크립트 성능에 대해 알아보자.
자바 스크립트 성능을 알아보자.
'~에 의해'
성능을 향상시키는 것은 코드 스타일을 다듬는 것에 의해 이뤄질 수 있다.
코드 스타일을 다듬어 성능을 향상할 수 있다.
'~을 통해'
성능 향상은 다음 3가지 방법을 통해 가능하다.
성능 향상은 다음 3가지 방법으로 가능하다.
'가능, 불가능하다'
성능 향상은 다음 3가지 방법으로 가능하다.
성능 향상 방법은 다음 3가지다.
'자유도가 높다'
원하는 기능을 선택해 적용할 수 있어 자유도가 높습니다.
원하는 기능을 자유롭게 선택할 수 있습니다.
'~을 가지고 있다'
모바일 기기들은 기종별로 다양한 해상도를 가지고 있습니다.
모바일 기기의 해상도는 기종별로 다릅니다.
'~경우'
관리 페이지 호출의 경우 다음과 같은 순서로 관리 페이지가 표시됩니다.
관리 페이지를 호출하면 다음과 같은 순서로 관리 페이지가 표시됩니다.
'통해'는 명확한 표현으로 바꾼다
이번 테스트에서 나타난 문제점 파악을 통해 부족한 기능을 보완하면 판매가 늘 것이다.
이번 테스트에서 나타난 문제점을 파악해 부족한 기능을 보완하면 판매가 늘 것이다.
네트워크를 통해 전송합니다.
네트워크로 전송합니다.
빌드 버튼을 통해 빌드를 생성합니다.
빌드 버튼을 클릭해 빌드를 생성합니다.
'~해 주다' 대신 '~하다'를 쓴다
Google 계정으로 로그인을 사용하려면 다음과 같이 구현해 주어야 합니다.
Google 계정으로 로그인을 사용하려면 다음과 같이 구현해야 합니다.
조사를 덜어낸다
시스템 사용을 하기 전에 환경부터 설정을 해야 합니다.
시스템을 사용하기 전에 환경부터 설정해야 합니다.
환경 설정의 편리함
편리한 환경 설정
사용자들과의 의견의 교환으로 프로그램의 개선을 이룰 수 있었다.
사용자들과의 의견을 교환해 프로그램을 개선할 수 있었다.
자주 틀리는 외래어 표기법
| 원문 | 잘못된 표현 | 올바른 표현 |
|---|---|---|
| application | 어플리케이션 | 애플리케이션 |
| directory | 디렉토리 | 디렉터리 |
| app | 어플 | 앱 |
| locale | 로케일 | 로캘 |
| shell | 쉘 | 셸 |
| release | 릴리즈 | 릴리스 |
| parameter | 파라메터 | 파라미터 |
| thumbnail | 썸네일 | 섬네일 |
| badge | 뱃지 | 배지 |
| solution | 솔루션 | 설루션 |
| push | 푸쉬 | 푸시 |
| flash | 플래쉬 | 플래시 |
| column | 컬럼 | 칼럼 |
| conference | 컨퍼런스 | 콘퍼런스 |
| contents | 컨텐츠 | 콘텐츠 |
| mapping | 맵핑 | 매핑 |
| windows | 윈도우 | 윈도 |
| snapshot | 스냅샷 | 스냅숏 |
| alias | 알리아스, 앨리어스 | 에일리어스 |
| architecture | 아키텍쳐 | 아키텍처 |
| provision | 프로비젼 | 프로비전 |
| access | 억세스 | 액세스 |
| drop | 드랍 | 드롭 |
| launching | 런칭 | 론칭 |
| repository | 레포지터리 | 리포지터리 |
| message | 메세지 | 메시지 |
| manifest | 매니패스트 | 매니페스트 |
자주 틀리는 문장 부호
마침표(.)
12월 26일에 출시 예정입니다
12월 26일에 출시 예정입니다.
2020. 12. 26
2020. 12. 26.
쌍점(:)
개발자를 위한 테크니컬 라이팅 가이드 : 50가지 팁
개발자를 위한 테크니컬 라이팅 가이드: 50가지 팁
큰따옴표(" ")
직접 인용할 때
배달 앱 기획자는 "앱을 직관적으로 사용할 수 있게 하는 것이 목표였습니다."라고 말했다.
책 제목을 나타낼 때
2021년에 출간된 "테크니컬 라이팅 기본"은 개발자가 글을 쓸 때 참고하면 좋은 책이다.
작은따옴표(' ')
인용한 말 안에 있는 인용한 말
"시각 자료를 활용하면 이해도가 높아집니다. '백문이 불여일견'이라는 말도 있듯이 말입니다."
문장 중 중요한 부분을 나타낼 때
데이터를 서로 비교할 때는 '표'를 사용하면 좋습니다.
소제목을 나타낼 때
문장부호 사용법은 '문장부호 바로 쓰기' 절을 참고합니다.
참조
