#일관되게 쓰기

기술 문서에서 용어와 표현을 일관되게 사용하는 것은 독자의 이해도를 높이고 문서의 신뢰도를 유지하는 데 중요해요. 같은 개념을 여러 방식으로 표현하면 독자가 혼란을 느낄 수 있으며, 검색과 탐색에도 불편함이 생길 수 있기 때문이죠.

기술 용어는 공식 표기를 따르고, 외래어 표기법은 업계에서 일반적으로 사용되는 형태를 따르는 것을 권장해요.

#체크리스트

#✅ 공식 기술 용어를 따르세요

개발 도구, 언어 등 기술 용어는 위키피디아 및 공식 문서의 이름 표기를 따르세요. 대소문자 표현에 유의하세요.

#✅ 같은 개념을 여러 방식으로 표현하지 마세요

하나의 문서 안에서 같은 개념을 여러 방식으로 표현하면 독자에게 혼란을 줍니다. 의미가 같다면 표현을 일관되게 쓰세요.

#✅ 약어는 먼저 풀어쓴 후 사용하세요

괄호 안에 전체 이름을 써주세요. 약어와 괄호 사이는 띄어 쓰지 마세요. 영문 약어를 풀어쓸 때는 전체 이름으로 표현해 주세요.

#✅ 외래어 표기는 사용 빈도를 고려하세요

기술 문서에서 외래어 표기는 항상 맞춤법을 따르기보다는, 가독성과 독자의 익숙함을 고려해서 업계에서 일반적으로 쓰이는 표현을 고려합니다.

토스에서는 구글 트렌드 기준으로 외래어 표기법보다 5배 이상 많이 사용되는 표기가 있으면 그 표기를 사용해요.

#실습 문제

아래 문장을 더 일관된 표현으로 수정해 보고, 답과 비교해 보세요.

#1. 공식 기술 용어를 따르세요

이 문서에서는 "자바스크립트 비동기 실행 방식"을 설명합니다.

정답 확인

이 문서에서는 "JavaScript의 비동기 실행 방식"을 설명합니다.

#2. 약어는 먼저 풀어쓴 후 사용하세요

CSR은 초기 페이지 로딩 속도를 높이는 데 유용합니다.

정답 확인

클라이언트 사이드 렌더링(Client-Side Rendering, CSR)은 초기 페이지 로딩 속도를 높이는 데 유용합니다.