시작하며
안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영)입니다.
다양한 글을 쓰거나 읽다 보면 문장 부호를 자주 접하게 되실 텐데요. 이런 문장 부호 사용 방법에 대해 다들 잘 알고 있다고 생각하고, 아마 무심하게 지나가시는 분들이 많을 것이라 생각합니다. 저희 테크니컬라이팅 팀에서도 처음에는 당연히 잘 알고 있다고 굳게 믿었던 문장 부호들이 문서에서 명확하게 사용되지 않고, 무분별하게 남용되거나 사용에 대한 혼란을 겪고 있는 모습을 발견하게 되었습니다. 이러한 문제를 해결하기 위해 문장 부호에 대한 가이드라인을 정립하고 준수해 보니 내부적으로 문장 간의 관계나 문장 내의 논리 구조가 명확해지고, 이로 인해 글쓴이의 의도가 명확하게 전달되었음을 느낄 수 있었습니다. 여러분들은 저희가 거쳤던 혼란을 겪지 않길 바라며 한국어 어문 규정을 토대로 알아본 정확한 용법과 예시를 공유하고자 합니다.
문장 부호 어문 규정 분석
영어에서는 APA Style과 시카고 스타일 매뉴얼(The Chicago Manual of Style)에서 문장 부호 용법에 대해 상세히 규정하고 있습니다. 한국어의 경우에는 국립국어원의 한국어 어문 규정의 부록에 문장 부호에 대한 규정과 용법을 규정하고 있습니다. 혹시 문장 부호는 생김새도 똑같은데 영어의 문장 부호 규칙이 그대로 국어에도 적용되지는 않을까 궁금해하시는 분들도 계실 텐데요. 결론적으로 영어와 국어에서의 문장 부호 규범은 다소 차이가 존재합니다. 예를 들어, APA Style에서는 쉼표(Comma)를 3개 이상의 항목을 열거할 경우에만 사용하도록 규정하고 있습니다. 반면, 국립국어원의 규정에는 최소 열거 항목에 대한 숫자 등은 제시가 되어있지 않고, 작성자의 의도에 따라서 자율적으로 사용하기를 권장하고 있습니다. 이처럼 같은 문장 부호라고 할지라도 언어별 특성에 따라 그 쓰임이 다르다는 사실을 이해해야 합니다. 그럼, 한국어 어문 규정에서 제시하고 있는 문장 부호 중 기술문서에서 주로 사용하는 문장 부호에 대해 자세히 살펴보겠습니다.
쉼표
한국어 어문 규정에서는 쉼표( , )의 용법을 15개로 구분하여 규정하고 있습니다. 이 규정은 크게 열거의 쉼표, 문장 구조의 쉼표, 동격의 쉼표로 구분할 수 있습니다. 테크니컬 라이팅에서는 쉼표를 포함한 모든 문장 부호를 정확하게 써야겠지만, 특히 쉼표는 사용 유무에 따라 독자가 받아들이는 문장의 뉘앙스가 달라질 수 있고, 무분별한 쉼표의 사용으로 문서의 가독성이 저하될 수 있는 문제가 있기 때문에 특히 주의해서 사용해야 합니다.
국립국어원은 쉼표의 붙임 해설에서 작성자의 판단에 따라 쉼표를 사용 혹은 생략할 수도 있다고 규정하고 있는데요. 이는 쉼표의 사용을 엄격하게 규정하기보다는 어느 정도 글쓴이의 판단에 맡긴 것으로, 개인적인 글에서는 이런 자유로운 쉼표의 사용이 큰 문제가 되지 않습니다. 하지만, 문서의 통일성과 일관성이 중요한 테크니컬 라이팅 측면에서는 문제가 될 수 있습니다. 이와 관련하여, 테크니컬라이팅 팀에는 <기술문서의 쉼표 사용 가이드라인> 아티클에서 쉼표의 무분별한 사용에 따른 문서의 가독성 측면을 분석하고, 쉼표 사용 가이드라인을 정립한 바 있는데요. 관심이 있으신 분들은 한번 읽어보시면 좋을 것 같습니다.
빗금과 가운뎃점
빗금과 가운뎃점은 쉼표와 비슷한 역할을 하는 문장 부호 중 하나입니다. 빗금과 가운뎃점은 그 용법이 비슷하기 때문에, 명확한 용법을 모른다면 두 문장 부호를 혼동해서 사용할 수 있는데요. 먼저 한국어 어문 규정을 살펴보고 빗금과 가운뎃점의 정확한 용법을 살펴보겠습니다.
빗금
빗금( / )은 쉼표를 대신하여 사용되는 경우가 많습니다. 한국어 어문 규범에서는 빗금에 대해 아래와 같이 규정하고 있습니다.
이 중에서 기술문서에서 자주 사용하는 용법은 (1) 대비되는 두 개 이상의 어구를 묶어 나타낼 때 그 사이에 쓴다 입니다. 기술문서에서는 요청 예시(Request Example)와 응답 예시(Response Example) 등 대비되는 개념을 설명하는 경우가 많은데, 이 경우 쉼표 대신 빗금을 사용할 수 있습니다. 이렇게 쉼표 대신 빗금을 사용하는 이유는 무분별한 쉼표 사용으로 문서의 가독성이 저하될 수 있는 문장에서 쉼표를 대체하기 위해서 인데요. 쉼표와 빗금은 사용법에 있어 틀리고 맞고가 없지만, 쉼표가 너무 많이 사용되는 문장에서라면 빗금을 사용하여 가독성을 개선할 수 있을 것입니다. 즉, 빗금은 개념상 대비가 되는 어구들을 하나로 묶어서 나타낼 때 사용하며, 쉼표가 많이 사용된 문장에서 쉼표를 대체하는 문장 부호로써 사용한다고 이해하시면 될 것 같습니다.
가운뎃점
가운뎃점( • )도 빗금과 마찬가지로 쉼표를 대신해서 사용할 수 있지만, 열거할 어구들을 일정한 기준으로 묶어서 표현할 때 사용된다는 점에서 빗금의 용법과 구분됩니다. 한국어 어문 규범에서는 가운뎃점에 대해 아래와 같이 규정하고 있습니다.
이 중에서 기술문서에서 자주 사용하는 용법은 (2) 짝을 이루는 어구들 사이에 쓴다 입니다. 기술문서에서는 다음 예시와 같이 ‘A는 B, C, D로 구성되며, E는 F, G, H로 구성됩니다’라는 식의 문장이 많이 사용되는데, 이 경우 열거할 어구들에 일정한 기준이 있는 경우에는 쉼표를 대신해서 가운뎃점을 사용할 수 있습니다. 빗금과 마찬가지로, 쉼표와 가운뎃점도 상호 호환되어 사용되므로, 쉼표가 너무 많이 사용되는 문장이면서 열거할 어구들에 일정한 기준이 있는 경우에는 가운뎃점을 사용해 보는 것도 좋을 것 같습니다.
쌍점
쌍점( : )은 추가적인 설명을 위한 문장 부호로 자주 사용되는데요. 한국어 어문 규범에서는 쌍점에 대해 다음과 같이 규정하고 있습니다.
쌍점은 다양한 용법으로 사용되지만, 기술문서에서 자주 사용되는 경우는 (1) 표제 다음에 해당 항목을 들거나 설명을 붙일 때 쓴다 입니다. 다음 예시처럼, 특정 표제에 대해 예시를 들거나 설명을 보완할 때 쌍점을 사용하면 됩니다. 저희는 특히 파라미터나 응답값에 대한 설명에 쌍점을 많이 사용하고 있습니다.
따옴표
따옴표는 큰따옴표와 작은따옴표로 구분되며, 말이나 글을 인용할 때나 어떤 용어나 문구를 강조하고 싶을 때 사용됩니다. 큰따옴표와 작은따옴표는 상호 대체할 수 없으며 엄연히 그 용법이 다르므로, 정확한 용법을 익혀두어야 합니다. 그럼 한국어 어문 규범을 기준으로 큰따옴표와 작은따옴표의 용법을 살펴보도록 하겠습니다.
큰따옴표
한국어 어문 규범에서는 큰따옴표( " " )에 대해 다음과 같이 규정하고 있습니다.
이 중에서 기술문서에서는 (2) 말이나 글을 직접 인용할 때 쓴다의 용법이 주로 사용됩니다. 카카오 i 기술문서에서는 사용자의 음성명령에 대해 인공지능 스피커가 응답하는 시나리오를 설명하고 있는데요. 이 시나리오에서 사용자의 발화나 스피커의 응답 등을 인용하기 위해 큰따옴표를 사용하였습니다. 다시 말해 큰따옴표는 모바일, 월패드, TV 등과 같은 디스플레이 기기에서 출력되는 말이나 화면에 표시되는 문구 등을 인용할 때 사용할 수 있습니다.
이 밖에 제13항의 붙임에서는 문장 안에서 책의 제목이나 신문 이름 등을 나타낼 때에도 큰따옴표를 쓸 수 있다고 규정하고 있는데요. 카카오 i 기술문서에서는 문서명에 대부분 해당 문서의 링크를 적용하여 강조하므로 큰따옴표를 사용하고 있지 않지만, 링크를 연결할 수 없는 외부 문서 등은 큰따옴표로 강조할 수 있다는 점을 기억해 두면 좋을 것 같습니다.
작은따옴표
문서에서는 어떤 단어나 구문을 강조할 때 작은따옴표( ' ' )를 사용할 수 있습니다. 한국어 어문 규범에서 정하고 있는 작은따옴표의 규칙은 다음과 같습니다.
위 규칙만 보면 작은따옴표가 기술문서에서 사용될 경우는 별로 없어 보이지만, ‘제18항의 붙임’에는 문장 내용 중에서 주의가 미쳐야 할 곳이나 중요한 부분을 특별히 드러내 보일 때에도 작은따옴표를 쓸 수 있다고 규정하고 있습니다. 즉, 문서에서 어떤 단어나 구문을 강조할 때 따옴표를 사용하고 싶다면, 큰따옴표가 아닌 작은따옴표를 사용해야 합니다. 또한, ‘제14항의 붙임’에서는 소제목, 그림이나 노래와 같은 예술 작품의 제목, 상호, 법률, 규정 등을 나타낼 때도 작은따옴표를 쓸 수 있다고 규정하고 있으니, 참고하시면 좋을 것 같습니다.
괄호
한국어 어문 규범에서는 소괄호, 중괄호, 대괄호의 세 가지 괄호를 소개하고 있습니다. 이 중 기술문서에서 많이 사용되는 소괄호와 중괄호에 대해 관련 규정을 살펴보겠습니다.
소괄호
소괄호( )는 가장 대중적으로 사용되는 괄호 유형입니다. 한국어 어문 규범에서는 소괄호의 용법을 다음과 같이 규정하고 있습니다.
테크니컬라이팅 팀에서도 소괄호를 많이 사용하고 있는데요. 카카오 i 기술문서에서 사용한 소괄호들을 찾아보니 (1)번, (2)번, (6)번의 용법에서 소괄호를 많이 사용하고 있었습니다.
중괄호
중괄호{ }는 소괄호보다 특정한 경우에 사용됩니다.
이 중에서 기술문서에서는 (2) 열거된 항목 중 어느 하나가 자유롭게 선택될 수 있음을 보일 때 쓴다 용법을 많이 사용합니다. 카카오 i 기술문서에서는 일반 사용자 가이드에서 사용자가 선택할 수 있는 옵션을 열거할 때 중괄호를 사용하여 표시하고 있습니다. 또한, 중괄호는 코드 예제에서 개발자가 선택하여 입력할 수 있는 값을 표기할 때도 많이 사용되므로 API 문서 작성 시 참고하시면 좋을 것 같습니다.
마치며
오늘은 기술문서에서 많이 사용되는 문장 부호의 용법과 예시를 살펴보았습니다. 모든 문장 부호의 규정과 용법을 외우는 것은 어렵겠지만, 적어도 기술문서에서 많이 등장하는 문장 부호에 대해 정확한 쓰임을 이해한다면 더 좋은 문서를 만들어 낼 수 있을 것입니다. 문장 부호는 그 종류만큼이나 용법도 다양한데요. 쉼표처럼 써도 되고 안 써도 되는 비교적 용법이 자유로운 문장 부호도 있지만, 큰따옴표와 작은따옴표처럼 그 용법이 명확하게 구분되는 문장 부호도 있습니다. 쉼표처럼 용법이 유연한 문장 부호는 사용 유무에 큰 문제는 없겠지만, 큰따옴표와 작은따옴표처럼 용법이 명확하게 구분되는 문장 부호는 반드시 정해진 용법을 지켜야 할 것입니다.
한국어 어문 규정에는 오늘 설명드린 문장 부호 외에 느낌표, 겹낫표, 줄표 등 다양한 문장 부호에 대한 규정과 용법을 제시하고 있는데요. 문장 부호에 관심이 있으시면 한국어 어문 규정의 문장 부호 챕터를 살펴보시면 좋을 것 같습니다. 그럼 앞으로도 더 좋은 기술문서를 만들기 위해 연구하고, 다음에도 유익한 내용으로 찾아오겠습니다.
Crystal (김유리)
사용자의 입장에서 생각하고, 개발자와 원활한 소통을 할 수 있는 Communication Skill을 가진 Technical Communicator입니다.
카카오엔터프라이즈의 값진 기술들을 정확하고 명확하게 전달하고, 신뢰를 쌓을 수 있는 문서를 만들고자 합니다.
Sandy (차신영)
산더미처럼 쌓여진 문서 정리, 새로운 문서화 도구 테스트, 그리고 구글링이 취미인 Technical Communicator입니다.
댓글