글 다듬기
기술 문서라면 주어와 목적어를 생략하지 말자
우리나라 말은 주어 생략을 허용한다. 문맥상 주어가 무엇인지 알 수 있는 경우에 한한다. 그러나 기술 문서에서만큼은 주어와 목적어를 생략하지 말자. 다른 장르의 글과 달리 수많은 메소드, 함수, 변수 등이 등장하는 기술 문서에서 주어나 목적어를 생략하면 아직 개념과 원리를 이해하지 못한 독자는 생략된 주어/목적어가 무엇인지 여러번 읽고 읽으며 찾아야 한다. 따라서 기술 문서라면 주어와 목적으로 생략하지 마라.
수식어와 피수식어는 최대한 가깝게 붙여써라
설치가 복잡한 것을 설명하는 예시 둘을 보자. 다음 두 문장 중 어떤 문장이 옳은 문장일까? ‘복잡한’이 무엇을 꾸미는가? 설치 과정이 복잡한 것이기에 ‘복잡한’을 설치 앞에 두는 게 옳다(예시 1). 이처럼 꾸미는 말과 그 대상을 가까이 붙여 쓰는 습관을 들이자.
- 예시 1 : 소프트웨어의 복잡한 설치 과정(O)
- 예시 2 : 복잡한 소프트웨어의 설치 과정(X)
“생각합니다”는 생략하라
글에는 자신의 주장과 생각이 담긴다. 그렇기에 이렇게 생각합니다라고 굳이 쓸 필요는 없다. 이런 모호한 문체는 주장의 힘을 잃게 만든다. 모든 글에는 저자의 생각과 의견이 담겼다. 이 당연한 사실을 망각하지 말자.
주어, 술어를 일치시켜라
문장이 길어지다 보면 주어와 술어가 꼬일 수도 있다. “그 장난감 가게는 이용 가격을 동결해 경쟁력을 높이겠다는 복안이다.”와 같이 주어와 술어가 꼬이지 않게 주의해야 한다. 이때는 주어와 술어를 붙였을 때 말이 되어야 한다. “가게는 복안이다”는 비문이다. “가게는 복안을 갖고 있다”는 말이 된다. 문장이 긴 경우는 주어와 술어를 따로 붙여서 살펴보자.
“A는 A다”라는 문장은 쓰지 말라
“A는”에서 이미 무엇인지 밝혔는데, 재차 “A다”라고 정의할 이유가 없다. 따라서 “A는 ~ 입니다.”처럼 쓰는 게 바람직하다.
- 예시 | 구름IDE 서비스는 땡땡땡하는 서비스입니다.(X)
- 구름IDE는 땡땡땡하는 서비스입니다. (O)
‘~을/를 통해’는 분명한 표현으로 바꿔라
“~ 통해”는 영어 through의 번역체로, 의미가 모호해 ‘거시기’처럼 남발해 쓰기 쉽다. ‘통해’보다는 의미가 분명한 단어를 명확하게 쓰자.
예: 구름 서비스를 통해 소프트웨어를 개발했다(X)
→ 구름 서비스를 이용해 소프트웨어를 개발했다(O)
‘의’는 대부분 빼도 무방하다.
‘의’가 일본 잔재인지 아닌지 논란과 관계 없이 우리말에서는 ‘의’ 대신 단어와 단어를 연결하면 의미가 대체로 통한다. 부득이한 경우를 제외하면 ‘의’는 생략하자.
‘들’을 빼고 복수를 복수로 쓰지 마라
한국어에서 복수는 단수 개념과 같은 무표형이나, 형태소 ‘들’을 명사에 붙이는 유표형으로 표현할 수 있다. 그런데, 복수 형태소 ‘들’은 대부분 생략하는 게 문장이 더 자연스럽다. 특히 형용사 “많은” 뒤의 명사에 복수 어미 ‘들’을 붙이는 일은 주의하자.
피동태보다는 능동태가 이해가 쉽다
주어 의지로 동작하는 것은 능동, 주어 의지와 달리 동작하게 되는 것은 피동이다. 글을 쓸 때에는 피동태는 가급적 피하는 게 좋다. 피동태보다는 능동태가 글을 이해하기가 더 쉽다고 한다.
사실과 의견을 구분하라
글에서 검증되지 않은 의견을 사실인냥 쓴다면 신뢰성이 떨어진다. 사실이라면 명확하게 “~이다”, 의견이라면 “~인 것 같다.”, “~인 듯하다”처럼이 사실과 의견을 구분해 쓰자.
쉼표를 남발하지 말라
쉼표는 쉬어 읽으라는 의미의 문장 부호다. 문장에서 불필요한 곳에 쉼표를 남발하지 말자. 나열을 제외한 대부분의 경우 쉼표를 넣지 않아도 된다.
문장은 짧게! 가급적 짧게 써라
글이 길고, 문장의 구조가 복잡할수록 이해하기가 쉽지 않다. 글이 길다면 해석해야 할 데이터가 많은 것과 같기 때문이다. 따라서 기술 문서라면 글을 짧고 명확하게 쓰자. (읽기 좋은 코드는 분량만으로 정해지진 않지만) 같은 알고리즘을 100줄로 짠 것과 5줄로 짠 것 중 어느 것이 이해하기 좋을까?
문장은 최대한 짧게, 짧게 쓰는 버릇을 들이자.
쉼표로 나열할 때는 같은 자격의 어구를 열거하라
“AWS, MS, 애플, 애저, 인텔, AMD, SAP⋯”.
이 문장에서 이상한 점이 없는가? 흔히 많이 하는 실수는 이처럼 쉼표로 나열을 할 때 자격이 같지 않은 어구를 함께 열거하는 것이다. 회사 이름을 나열한다면 ‘같은 자격’의 회사 이름만 나열해야 한다. ‘애저’ 같은 제품명이 그 사이에 끼어서는 안 된다.
소리내 읽고 읽어라
수많은 글쓰기 강의, 팁에서 빠트리지 않고 말하는 것. 바로 소리내 읽고 읽으라는 것이다. 잘 읽히지 않는다면 말로 이야기하듯 문장을 고쳐라.
다음날 다시 읽어라
흔히 자신의 글은 스스로가 교정/교열하지 못한다고 한다. 오탈자가 있고, 맞춤법이 틀리고 비문이더라도 무엇을 얘기하는지가 머릿속에 있기 때문에 오탈자가 눈에 잘 들어오지 않는다. 이런 현상은 첫 글자와 마지막 글자만 맞으면 틀린 단어일지라도 정확한 의미와 단어로 인식하는 단어 우월 효과(Word superiority effect)라는 심리 효과 때문인지는 모른다.
원인이 무엇이든 이런 문제에서 벗어나려면 ‘시간’을 두고 글을 다듬는 게 좋다. 다음 날 어제 쓴 글을 다시 읽는 것이다. 어제 미처 보이지 않던 비문이 오늘은 보일 것이다.
‘접속사’는 자제하라
여러분이 쓴 글이 있다면, 그 글에서 접속사를 지워봐라. 소리내어 읽어보라. 어떤가? 접속사를 지워도 읽는데도 어색하거나 이상하지 않을 것이다. “하지만”, “그러나” 같은 서로 상반된 사실의 문장을 이어지는 접속사가 아니라면, 가급적 접속사를 생략하라.