번역 저서 글쓰기 지침 - 위키북스
저술시 출판사에서 받은 글쓰기 지침인데 다른 분들께도 도움이 될 것 같아서 출판사의 허락을 받고 공개합니다.
글쓰기 지침
간결하게 쓴다
- 초점을 맞추었다 -> 초점을 맞췄다.
- 정리하여 -> 정리해서, 정리해
- 실시하였으며 -> 실시했으며
- 추가되었으면 하는 -> 추가됐으면 하는
- 정의되어 있지만 -> 정의돼 있지만
- 이루어지지 않은 -> 이뤄지지 않은
- 서버이다 -> 서버다
- 마찬가지이다 -> 마찬가지다
- 하나이다 -> 하나다
- 알아보았다 -> 알아봤다
- 알아보도록 한다 -> 알아보겠다, 알아보자, 알아본다
- 클릭하여 -> 클릭해
- 생각해 보아야 한다 -> 생각해봐야 한다
- 예제이다 -> 예제다
- 원활한 커뮤니케이션을 할 수 있도록 -> 의사소통이 원활하게
되도록 수동태 표현이나 사역형 표현은 쓰지 않는다
- 사람들에 의해 만들어지는 이상 -> 사람이 만드는 이상
- 작성된다는 건 -> 작성한다는 건
- Left 값 또는 right 값이 입력되지 않으면 -> left 값이나 right 값을 입력하지 않으면
- 픽스처가 작성되지 않았기 -> 픽스처를 작성하지 않았기
- 실행시키면 -> 실행하면
가급적 쉬운 표현을 쓴다
- 변화된다 -> 바뀐다
- 동일하다 -> 같다
- 생성한다 -> 만든다
명사형 표현을 과도하게 쓰지 않는다
- 코드 품질 향상을 위한 -> 코드 품질을 향상시키기 위한
- 품질 개선 영역 식별 및 의사 결정 판단 근거를 -> 품질을 개선할 영역을 식별하거나 의사 결정에 필요한 근거를
- QP 적용 지원 도구 사용 과정에서 발생하는 -> QP 적용 지원 도구를 사용하는 과정에서 발생하는
- 테스트 코드 작성이 용이해짐 -> 테스트 코드를 작성하기가 쉬워짐
- 이해가 훨씬 빠를 것이다 -> 훨씬 빨리 이해할 것이다
불필요한 조사를 뺀다
- 실행을 한다 -> 실행한다
- 도입을 했다 -> 도입했다
- 컴파일이 되지만 -> 컴파일되지만
쉼표 사용을 가급적 자제한다
한 문장 안에서 앞 뒤 절의 의미가 바뀌거나 하는 부분에 대해서만 제한적으로 사용한다.
- 결과는 어떤지, 위원회에서 -> 결과는 어떤지 위원회에서
- 따라서, -> 따라서
- 하지만, -> 하지만
- 그러나, -> 그러나
- ~하는 대신, -> ~하는 대신
- 나타나, -> 나타나
- 때문에, -> 때문에
- 통합 테스트란, -> 통합 테스트란
영어 표현은 가급적 한글 표현으로 대체한다
- 오버헤드 -> 부담
- 퀄리티 -> 품질
- 커뮤니케이션 -> 의사소통
- 코디네이션 -> ??
- 디자인 -> 설계
- 디폴트 -> 기본값
- 리턴 -> 반환
- 파라미터 -> 매개변수
자주 쓰는 표현은 가급적 한글로 표기한다
- Java -> 자바
- ActionScript -> 액션스크립트
- JavaScript -> 자바스크립트
- Windows -> 윈도
영문 병기는 처음 나올 때만 쓴다
표현을 일관되게 쓴다
- 디자인, 설계
- 커뮤니케이션, 의사소통
- 릴리스, 릴리즈, 출시
- 체크 리스트, 점검 목록
가려 써야 할 표현
'-의'
- 좋은 품질의 제품 -> 품질 좋은 제품
- 검증의 수단으로서 -> 검증 수단으로
- 소규모의 프로젝트에서나 -> 소규모 프로젝트에서나
'-들'
우리말은 단수형으로 쓰더라도 복수형의 의미도 지니므로 정확히 복수형임을 나타낼 필요가 없다면 가급적 '-들'을 쓰지 않는다.
- 하위 클래스의 메서드들은 -> 하위 클래스의 메서드는
'경우', '경우에는'
- 적을 경우 -> 적다면
- 일부 조직의 경우에는 자발적으로 -> 일부 조직에서는 자발적으로
- 수행해야 하는 경우에는 자동으로 -> 수행해야 할 때는 자동으로
'-위해'
- 적용하기 위해 필요한 기술 환경 구축 -> 적용하는 데 필요한 기술 환경 구축
- 개선되었는지 판단하기 위해서 -> 개선됐는지 판단하려면
- 검증범위를 넓히기 위해 활용할 -> 검증 범위를 넓히는 데 활용할
'및'
- A 소개 및 도입 목적을 -> A를 소개하고 도입 목적을
'때문에'
- 특성이 다르기 때문에 -> 특성이 다르므로, 특성이 달라
'-도록'
- 역량을 갖출 수 있도록 하였다. -> 역량을 갖추게 했다, 역량을 갖출 수 있게 했다, 역량을 갖출 수 있게끔 했다
- 알아보도록 하자 -> 알아보자
- 이야기하도록 하겠다 -> 이야기하겠다
의미가 모호한 '제공하다'의 남발
- 기술 교육을 제공하여 -> 기술 교육을 실시해
- 컨설팅을 제공했다 -> 컨설팅했다
추측성 '~것이다'의 남발
- 내재화하기 어려울 것이다. -> 내재화하기 어렵다.
군더더기 '-서'
- 되어서 -> 되어
- 하여서 -> 하여
- ~하는 데 있어서 -> ~하는 데 있어
의미상 중복되는 표현
- 기존 레거시 코드 -> 레거시 코드
'~되다'
- 가능하게 되었다 -> 가능해졌다
- 기여하게 된다 -> 기여한다
- 높아지게 된다 -> 높아진다
- 차지하게 될 것이다 -> 차지할 것이다
영어의 have에서 비롯된 '가지다'
- 유사한 구조를 가지고 있지만 -> 구조가 유사하지만
- 경향을 갖는다 -> 경향이 있다
'이루어지다'
- 부분에 변경이 이루어져야 한다 -> 부분을 변경해야 한다
'요구되다'
- 개선이 요구된다 -> 개선이 필요하다, 개선할 필요가 있다, 개선해야 한다.
불필요한 과거형 표현
- 경험했던 -> 경험한
- 처음에 했던 -> 처음에 한
- 해봤던 -> 해본
- 설명했던 -> 설명한
영어의 for에서 비롯된 '대해/대한'
- 넥타이 매는 방법에 대해 설명할 때 -> 넥타이 매는 방법을 설명할 때
- 사칙 연산 기능에 대한 일부 설명을 발췌하였다 -> 사칙 연산 기능을 설명한 내용 중 일부를 발췌한 것이다
- null에 대한 검사를 -> null 검사를, null 값 검사를
'~있다'
- 관계를 맺고 있다 -> 관계를 맺는다
- 맡고 있다 -> 맡는다
'안에'
폴더, 디렉터리, 컬렉션, 냉장고처럼 뭔가를 담는 것이 주 용도인 대상에 '안에'라는 표현을 덧붙이는 것은 군더더기다.
- 폴더 안에 파일을 저장한다 -> 폴더에 파일을 저장한다
- 디렉터리에 안에 파일을 추가한다 -> 디렉터리에 파일을 추가한다.
- 수박은 냉장고 안에 넣어라 -> 수박은 냉장고에 넣어라
'만약/만일'
- '~면'에 이미 가정의 의미가 들어 있으므로 굳이 '만약/만일'을 쓸 필요가 없음.
'사용/이용'의 남발
'쓰다'와 같은 표현을 쓰거나 적절하다면 '활용'과 같은 표현으로 대체한다. 또는 경우에 따라 아예 없애 버려도 무난하다.
- Null 객체가 사용될 수 있다 -> Null 객체를 활용할 수 있다
- Null 객체를 이용해서 -> Null 객체로
'각각의'
- '각', '각기'로 고쳐 쓴다.
'서로 다른(each other)'/'다른(other)'
- '그 외', '그 밖의', '기타', '~ 등'으로 고쳐쓴다.
생략해야 하는 표현
- 몇몇의, 약간의, 일련의, 어떠한, 단순히
틀리기 쉬운 맞춤법
- 그리고 나서 -> 그러고 나서
- 보다 점진적인 -> 더욱 점진적인
- see(보다)의 의미가 아닌 이상 비교급을 나타낼 때의 '보다'는 'A보다'라는 식으로 반드시 의존형으로 써야 함
- '로써', '로서'의 구분
- '~데'의 사용법
- 서둘러 갔는데 그는 가버리고 -> 붙여씀
- 하는 데 있어서, 실행하는 데 꼭 필요하다, 모니터링하는 데 쓰인다 -> 띄어씀
- '~지'의 사용법
- 할지 안할지 모르겠다, 설정할지 결정해야 한다, 쓰이는지에 따라 -> 붙여씀
- 실행한 지 오래됐다면, 만난 지 채 두 시간도 -> 띄어씀(시간을 나타낼 때)