개발자가 알아야 할 글쓰기 기본 - 문장을 작성하는 방법

개요

지난 포스팅에서는 개발자가 글을 못 쓰는 이유와 개발자의 글쓰기 세 가지 특징(정확성, 간결성, 가독성)에 대해 설명하였다. 이번 포스팅은 개발자가 글을 작성하기 전에 알아야 하는 기본에 대해 정리한다.

 

문장을 구조화하는 방법

토익을 처음 입문하면 '영어 5 형식 문장'에 대해 배우게 된다. 기본적으로 모든 문장은 주어, 동사가 존재하며 문장의 의미를 좀 더 자세하게 표현하기 위해 보어, 목적어, 수식어가 사용되기도 한다.

이러한 문장 구조는 한글도 마찬가지다. 한글에서도 문장을 표현하기 위해 기본적으로 주어와 동사를 사용하며 경우에 따라 보어, 목적어, 수식어가 사용되기도 한다. 신기한 점은 문장의 구조는 바뀔 수 있다는 것이고 어떻게 바뀌느냐에 따라 글을 쓰는 속도 그리고 글을 해석하는 속도가 달라진다.

 

예를 들어 다음 문장을 보자.

JavaScript에서 함수는 객체처럼 사용할 수 있으므로 일급 객체다.

이 문장을 작성하려면 'JavaScript에서 함수는 객체처럼 사용할 수 있다.'라는 문장과 'JavaScript에서 함수는 일급 객체다.'라는 문장을 연결하는 것까지 생각해야 하므로 글쓴이는 머리가 복잡해진다.

 

위 문장을 연결하지 않으면 다음과 같이 두 문장으로 나타낼 수 있다.

1. JavaScript에서 함수는 객체처럼 사용할 수 있다. 따라서, 함수는 일급 객체다.
2. JavaScript에서 함수는 일급 객체다. 객체처럼 사용할 수 있기 때문이다.

첫 번째 문장은 부가 설명을 먼저 말하고 핵심을 나중에 말했다. 이러한 문장의 단점은 독자가 부가 설명을 머릿속에 기억하고 있어야 핵심 내용을 이해할 수 있다는 것이다.

 

두 번째 문장은 핵심을 먼저 말하고 부가 설명을 나중에 말했다. 일반적으로 핵심보다 부가 설명이 많기 때문에 핵심을 먼저 작성하는 것이 좋다.

 

정리하자면 내가 설명하고자 하는 내용의 핵심과 부가 설명을 구분하고 핵심을 먼저 작성한 다음 부가 설명을 추가한다.

 

서술식, 개조식, 도식의 차이

글을 표현하는 방법은 크게 세 가지 방법인 서술식, 개조식, 도식으로 분류된다.

 

서술식은 문장처럼 '~다'로 끝나는 글을 말한다.

 

개조식은 책의 목차 또는 공지사항처럼 리스트로 작성된 글을 말한다.

 

도식은 관계 또는 구조를 나타내는 그림, 표, 도표를 말한다.

 

아래는 개인정보처림 방침 변경 안내에 대한 넥슨 공지 사항인데, 서술식과 개조식으로 작성된 것을 확인할 수 있다.

도식은 아래 그림처럼 클래스, 컴포넌트 구조 또는 ERD를 표현하기 위해 사용한다.

글을 표현하는 세 가지 방법인 서술식, 개조식, 도식은 서로 변환이 가능하다.

 

예를 들어 JavaScript에서 배열에 특정 문자열이 포함되어 있는지 확인할 수 있는 includes() 메서드를 서술식으로 설명한다고 하자.

includes() 메서드는 하나의 문자열이 다른 문자열에 포함되어 있는지를 판별하고 결과를 true 또는 false로 반환합니다. 검색 시 대소문자를 구분하며 문자열이 포함되어 있는지 판별하기 위해 시작 위치를 설정할 수 있습니다.

이 문장은 짧기 때문에 쉽게 이해할 수 있지만, 문장이 길어진다면 독자는 글을 이해하기 위해 많은 시간을 소모할 수 있다.

 

따라서 말로 구구절절 설명하는 것보다 개조식 또는 서술식 + 개조식으로 나타내는 것이 보기도 좋고 이해하기도 쉽다.

includes() 메서드는 하나의 문자열이 다른 문자열에 포함되어 있는지를 판별합니다.

includes(searchString)
includes(searchString, position)

매개변수
  searchString
  - 찾을 문자열
  
  position(생략 가능)
  - searchString을 찾기 시작할 위치

반환 결과
  포함되어 있으면 true, 아니면 false

중요한 것은 내용에 따라 표현 방법을 적절하게 사용해야 한다는 것이다. 줄거리가 있는 설명이나 말로 설명할 수밖에 없는 내용이라면 서술식으로 써야 하고 글을 구조화하거나 강조하고 싶은 내용이라면 개조식을 써야 하고 복잡한 구조를 설명해야 한다면 도식으로 써야 한다.

 

글머리 기호

글을 개조식으로 작성할 때는 글머리 특수 문자를 쓰는 것이 좋다. 글머리 기호는 다양하지만 아무렇게나 사용해서는 안되고 글 내용에 따라 적절하게 사용해야 한다.

 

글머리 기호는 주로 공지사항 또는 API 문서에서 볼 수 있는데 일반적인 설명을 나열하는 경우 ○, ●, ◇, ◆, □, ■, - 등 동그라미, 네모, 하이픈을 사용하고 중요한 내용을 설명하는 경우 당구장 기호(※)를 사용한다. 순서 또는 단계를 나타내는 경우에는 1, 2, 3, 가, 나, 다, ㄱ, ㄴ, ㄷ 등 숫자 또는 문자를 사용한다.

 

아래는 던전 앤 파이터 API 문서에서 개조식으로 작성된 글이며 중요한 부가 설명은 당구장 기호와 서술식으로 작성된 것을 알 수 있다.

글머리 기호를 작성할 때, 주의할 점은 하위 요소로 갈수록 부가 설명이 되면서 중요도가 낮아지므로 크기가 작아지고 들여 쓰기를 해야 한다는 것이다.

 

아래는 NAVER API 서비스 이용약관에서 이용자의 권리 및 의무에 대한 내용이다.

단락이 구조화되어 있으며 부가 설명에는 들여 쓰기가 적용된 것을 확인할 수 있다.

 

만약 아래와 같이 부가 설명으로 갈수록 글머리 기호의 크기가 커지고 들여 쓰기가 이상한 경우 독자는 문서의 체계 및 중요한 내용이 무엇인지 쉽게 이해할 수 없다.



대부분의 글은 좌측 상단에서 시작하므로 높은 계층에 핵심 내용을 작성하고 굵기, 밑줄, 가운데 정렬 등을 사용하여 고급스럽게 표현할 수 있도록 한다.

 

정리

• 문장을 작성할 때, 핵심을 먼저 작성하고 부가 설명을 추가한다.
• 글을 표현하는 방법으로 '~다'로 끝나는 서술식, 리스트로 작성된 개조식, 관계를 그림 또는 표로 표현하는 도식이 존재한다.
• 개조식은 하위 요소로 갈수로 폰트 및 글머리 기호의 크기가 작아야 하며 들여 쓰기를 해야 한다.

 

참고자료

[1] 도서 - 개발자의 글쓰기