[TW] 기술문서 쉽게 쓰기 지침

시작하며

안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 오늘은 ‘기술문서 쉽게 쓰기 지침’이라는 주제로 포스팅을 해 보려고 하는데요. 먼저 기술문서의 한 단락을 살펴보도록 하겠습니다.

어떠신가요? 일단 ‘역시 기술문서라서 어렵네’라는 생각을 하시는 분들이 많으실 텐데요. 다행히도 위 문장은 이번 주제를 함축적으로 설명하기 위해 가상으로 작성해 본 예시입니다. 사실 한국어의 경우 과거부터 한자어를 다수 포함한 만연체 문장이 널리 쓰였고, 최근까지도 각종 문서에서 외국어 번역체가 무분별하게 사용되고 있는 현실에 비추어 볼 때, 한국어에는 아직도 비직관적인 언어 습관이 많이 쓰이고 있는 것 같습니다. 오히려 과거에는 만연체나 번역투 문장이 더 트렌디하게 보였던 시기도 있었던것 같기도 하고요. 하지만 이런 어려운 언어는 기술 문서를 멋있는 것처럼 보여줄 수 있겠지만, 사실 가독성과 사용성을 크게 저하시킵니다.

저희 팀에서도 기술문서를 작성할 때, 독자들이 글을 직관적으로 이해할 수 있도록 더욱 쉬운 언어로 작성하려는 노력을 기울이고 있는데요. 이런 쉬운 언어 쓰기에 대한 움직임이 이미 국내외에서 활발하게 진행되고 있다는 사실, 알고 계셨나요? 우리나라의 경우, 쉬운 언어 쓰기에 대한 가장 대표적인 예로 법제처가 장기 프로젝트로 추진하고 있는 알기 쉬운 법령 만들기 사업을 들 수 있습니다. 이 사업은 소수의 전문가가 아닌 모든 국민이 법령을 쉽게 읽고 이해할 수 있도록 하기 위해 법령을 알기 쉽게 만드는 것을 목표로 하고 있습니다. 국외 사례로는 일본의 쉬운 일본어 지침, 미국의 PLAIN 언어 지침 등이 있습니다. 오늘은 이런 쉬운 언어 쓰기 움직임에 대한 국내외 사례 등을 살펴보고, 한국어 기술문서 전반에 적용할 수 있는 '기술문서 쉽게 쓰기 지침’에 대해 알아보도록 하겠습니다.

국내외 쉬운 언어 정책

앞서 우리나라뿐만 아니라 전 세계적으로 쉬운 언어 지침의 필요성이 주목받고 있다고 말씀드렸는데요. 많은 나라에서 과거 지식층 위주로만 읽히던 각종 문서가 일반 대중들을 타겟팅하게 되면서 쉬운 언어 정책의 필요성이 대두되었습니다. 미국, 일본, 프랑스 등 이민 국가들은 일찍이 공공 언어에 대한 지침을 만들었고, 특히 미국이나 캐나다 등 영어권 이민 국가들에서는 이민자들을 위해 공식 문서에 쉬운 언어를 사용할 것을 강제하고 있습니다. 그럼 국내외 사례들을 좀 더 자세히 살펴보도록 하겠습니다 .

▪ 일본의 쉬운 언어 지침

한국어와 비슷하게 일본어에서도 각종 문서가 불필요할 정도로 '어렵게' 작성되는 일이 있었는데요. 이에 따른 문제점을 해결하기 위해 최근 지자체에서 개선 지침을 내놓는 등 노력을 기울이고 있습니다. 한 예로 일본 사가현의 ‘관공서 언어 개선지침'을 들 수 있습니다.

📖 관공서 언어 개선지침

1. 가능하다면 구체적인 표현을 사용할 것
2. 결론을 먼저쓰고, 정확하고 간결한 문장 사용할 것
3. 행정에서 많이 사용되는 관용 표현은 재검토 할 것
4. 외래어는 보급된 것만을 사용할 것
5. 전문용어는 쉬운 용어로 대체하거나 부연 설명할 것
6. 명령어조는 지양할 것
7. 돌려서 장황하게 말하는 표현은 지양할 것
8. 긍정적이면서 진취적 표현 사용할 것
9. 경어 표현은 적절하면서 간결하게 사용할 것
10. 말의 혼동을 최소화 할 것
11. 레이아웃도 고려할 것
12. 친숙한 문서를 만들도록 노력할 것
13. 마지막으로 소리를 내어 작성한 문서를 읽어볼 것

이 밖에도 일본 정부는 쉬운 일본어(やさしい日本語)를 고안하여 널리 사용하고 있습니다. 이 지침은 1995년 고베 대지진 이후 재난 상황에서 일본어가 서툰 외국인들의 피해가 지적되자 일본 정부 차원에서 정한 지침인데요. 실제 이 지침은 NHK(일본 방송 협회)의 태풍 및 지진 등 각종 재난방송에 사용되고 있습니다. 쉬운 일본어에 대한 지침도 꽤 구체적인데요. 몇 가지 예를 소개하면 다음과 같습니다.

실제 사례를 보니 언어가 훨씬 쉬워진 것이 체감되시나요? 초등학교 1, 2학년 생들이 이해할 수 있는 정도의 쉬운 일본어를 사용하여 전달력이 개선되었고, 일본어에 대한 배경지식이 부족한 다른 문화권 출신 외국인 입장에서도 쉬운 일본어의 장점이 더욱 와닿을 것 같습니다.

이런 국가 차원의 쉬운 언어 쓰기 지침은 실제 재난 상황에서는 더욱 빛을 발휘하고 있는데요. 히로사키 대학(弘前大学)의 연구를 살펴보면, 재난 상황에서 “두부(頭部)를 보호하세요.”와 “모자를 써 주세요.”라는 지시문을 각각 했을 때 해당 대학에 재학 중인 유학생들은 “모자를 써 주세요”라는 지시에는 약 95%가 실행을 했던 반면, “두부(頭部)를 보호하세요.”라는 지시에는 약 10%만이 실행을 했다고 합니다. 쉬운 언어가 생명도 살릴 수 있다는 사실에서 쉬운 언어 쓰기의 중요성을 다시 한번 깨닫게 됩니다.

▪ 미국의 PLAIN 지침

[그림 1] 쉬운 언어와 연관되는 접근성 개념들 (출처: Migration Institute)

미국의 PLAIN 지침은 일종의 국가 프로젝트로서 대대적인 쉬운 언어 프로젝트가 시행된 사례로 주목할 만합니다. 과거 일부 지식인들이 그들만 알 수 있도록 작성해 왔던 미국의 각종 법률 문서를 일반인들이 제대로 이해할 수 없다는 사실이 대두되면서, 1970년대부터 연방정부 차원에서 연방관보(Federal Register)를 평이한 용어로 작성하라는 지시가 내려왔습니다.
같은 시기 씨티은행(Citi Bank)이 고객 친화적 은행 어음 서식을 내놓는 등 민간 영역에서도 쉬운 언어로의 전환이 이루어졌죠. 이후 쉬운 언어 정책은 행정부의 성향에 따라 부침을 겪다가 2010년 오바마 행정부 시절 '쉽게 쓰기 법령'(Plain Writing Act)이 제정되었습니다. 뉴욕주, 하와이주 등 일부 주에만 존재했던 '쉬운 언어 법'이 연방 차원으로 확대된 것입니다. 정부 기관의 적용 사례로는 FAA(연방항공청)의 문서작성 표준 보유, FDA(식품의약처)의 만성질환 예방 및 건강정보이해력 증대를 위한 쉬운 언어 행동계획(Plain Language Action Plan) 등이 알려져 있습니다.

미국에서 쉬운 언어가 정착하는 과정에서 '쉬운 언어활동 및 정보 네트워크'(Plain Language Action and Information Network, 이하 PLAIN)의 역할을 빼놓을 수 없는데요. PLAIN은 정부나 기업에 의해서가 아닌 자발적으로 조직되었으며 1994년 공식 조직이 되었습니다. PLAIN은 2011년 3월 '미연방 쉬운 언어 가이드라인'(Federal Plain Language Guidelines)을 발행하고, 연방기관들을 위한 쉬운 언어 작성 교육을 시행하고 있습니다. 또한 앞서 언급한 '쉽게 쓰기 법'에 따라 각 기관은 쉬운 언어활동 책임자를 임명해야 하는데, 인선 과정에서 PLAIN과 논의해야 합니다. 문서 가이드라인 제시, 리라이팅 지원, 글쓰기 교육 등 PLAIN이 수행하는 역할은 테크니컬라이터 와도 맞닿는 점이 있어 보입니다.

📖 미연방 쉬운 언어 가이드라인

1. 독자를 위해 써라 (Write for your audience)
2. 정보를 구조화하라 (Organize the information)
3. 단어를 신중히 선택하라 (Choose your words carefully)
4. 간결하게 써라 (Be concise)
5. 대화체로 써라 (Keep it conversational)
6. 읽기 좋게 시각화하라 (Design for reading)
7. 웹 표준을 지켜라 (Follow web standards)
8. 가설을 시험해 보라 (Test your assumptions)

▪ 한국의 알기 쉬운 법령 만들기

다시 한국의 사례로 돌아와 보겠습니다. 일본어의 쉬운 일본어 지침, 영어의 PLAIN 지침을 적용하기에는 (아직 이를 정책학적 시사점이 아닌 구체적 지침 기준에서 한국어에 맞게 현지화한 연구사례가 부족하여) 언어에 의해 발생하는 근본적인 차이를 간과하기 어렵다고 판단하였습니다. 따라서 한국어에 기반한 자료를 더 조사해 보았고, 다루고 있는 분야는 저희와 다소 차이가 있지만 법제처에서 10년 넘게 연구되고 있는 알기 쉬운 법령 만들기를 소개해 보려고 합니다.

법제처는 2006년부터 추진된 알기 쉬운 법령 만들기(알법) 사업에 대해 "국민 누구나 쉽게 읽고 이해할 수 있도록 한자어나 일본어식 용어, 전문용어 등의 어려운 법령용어를 쉬운 용어로 바꾸고, 길고 복잡한 법령 문장을 간결하고 명확하게 고쳐 나가는 사업"이라고 소개하고 있습니다. 세부적으로는 법령의 한글화, 어려운 법률용어 순화, 한글 맞춤법 등 어문 규범의 준수, 정확하고 자연스러운 법 문장의 구성, 체계 정비를 통한 간결화 및 명확화를 목표로 하고 있습니다. 과거의 법령을 정비함은 물론, 새로 만들어지는 법령을 입법 단계에부터 심사 및 리라이팅 할 수 있도록 하고 있습니다. 좀 더 구체적인 사례를 살펴보면, 법률 용어 중 일상생활에서 접하기 힘든 단어들이 비교적 친숙한 단어로 순화된 것을 확인할 수 있었습니다.

법제처는 [그림 2] '일본어 투 표현', '틀리기 쉬운 외국어 표기'도 정비의 대상으로 포함하고 있는데요. 전자는 불필요한 표현이나 어려운 표현을 삭제하기 위해서, 후자는 외국어 표기의 일관성을 유지하기 위해서 정비의 대상이 됩니다.

[그림 2] '일본어 투 표현', '틀리기 쉬운 외국어 표기' (출처: 법제처)

기술문서 쉽게 쓰기

테크니컬라이팅 팀에서는 앞서 소개한 국내외 쉬운 언어 정책 사례들을 조합하여, 한국어 기술문서를 쉽게 쓰는 방법에 대해 고민해 보았습니다. 이전 아티클 '언어학 관점에서의 기술문서 가독성 향상 전략'과 마찬가지로, 실제 기술문서 문장 예시를 통해 한국어 기술문서에 쉬운 언어 지침을 적용하는 방법을 살펴보도록 하겠습니다.

▪ 일본의 쉬운 언어 지침 적용

일본의 쉬운 언어 지침은 비슷한 한자어를 공유하는 한국어에 적용하기 수월한데요. 가령, 쉬운 일본어(やさしい日本語)를 사용할 때 '기입(記入)하다'는 말은 순화의 대상이 되기도 하였습니다.

어말에 들어가는 표현을 통일하여 예측 가능성을 높인 것도 쉬운 언어 지침의 특징이었습니다.

▪ 미국의 PLAIN 지침 적용

PLAIN 지침에는 '/'(슬래시) 등 문장 부호에 대한 내용을 참고할 수 있었습니다. 이는 구체적인 의미가 명확하지 않은 문장 부호이므로 영어로 치면 'and'의 의미를 가지는 단어로 바꿔 씁니다.

또한, 축약어 사용을 지양하는 PLAIN 지침에 따라 기술문서에서 불필요한 축약어를 사용하지 않도록 수정할 수 있었습니다. Android OS를 AOS로 줄여 쓰기도 하지만, 이는 iOS와는 달리 공식 표기법이 아니므로 풀어서 사용합니다.

▪ 한국의 알기 쉬운 법령 만들기 적용

알기 쉬운 법령 만들기에서는 한국어를 기준으로 한 지침이기 때문에 기술문서에 적용할 수 있는 부분도 많았는데요. 법률 용어만큼은 아니지만 기술 용어에도 어려운 용어가 많고, 잘못된 표현이 많이 쓰이고 있었습니다. 다음은 '유효성 여부'라는 중복 표현을 '유효성'으로 고친 예시입니다.

일본어 투 표현도 쉽게 고칠 수도 있었는데요. '1회에 한하여' 라는 자연스럽지 않은 표현을 '최초 한 번'으로 순화할 수 있었습니다.

마치며

이번 글에서는 국내외 여러 사례들과 더불어 쉬운 언어를 보편화하기 위해 어떤 노력들이 이루어지고 있는지 알아보고, 각 사례에서 제시된 지침들을 실제 기술문서에서 발췌한 문장에 적용해 보았습니다. 실제 언어정책 추진은 다양한 집단의 이해관계가 걸려 있으며 엄청난 규모의 자본과 노력이 투입되어야 하는 굉장히 복잡한 문제인데요. 숱한 어려움 속에서 쉬운 언어 정착에 성공한 사례들이 정말 반갑게 느껴졌습니다.

각종 쉬운 언어 지침들이 공통적으로 강조하는 원리는 테크니컬 라이팅의 원리와도 맞닿아 있었습니다. 먼저 쉬운 언어 쓰기는 그 지향점을 볼 때 명확성, 가독성, 간결성이라는 테크니컬 라이팅의 기본 요소가 녹아있었고, 독자를 위해서 정보를 정리하고 재구조화하는 것 또한 공통적이었습니다. 특히 '미국의 PLAIN 지침'을 보면 웹 표준 및 정보 구조화, 시각화에 대한 내용이 담겨 있는데, 마침 테크니컬라이팅 팀에서도 웹 표준을 준수하며 정보를 ‘더 좋은 방식으로’ 제공하는 방법을 고민하고 있어서 비슷하다고 느껴졌습니다. '쉬운 일본어 지침'에서 강조하는 안내 문구의 표기 통일 문제도 테크니컬라이팅 팀에서 제시하는 스타일 가이드와 통하는 부분이 있었습니다. 마지막으로 한국의 '알기 쉬운 법령 만들기'에서 강조하는 어문 규정 준수 및 외래어 표기 통일에 대해서도 문서 리뷰와 리라이팅 과정에서 확인하는 부분이었습니다.

카카오엔터프라이즈의 테크니컬라이팅 팀에서는 정확한 정보를 전달하면서도 읽기 쉬운 문서를 만들기 위해 다양한 노력을 기울이고 있는데요. 이번 글과 더불어 다양한 기술문서들이 더 쉽게 사용자들에게 다가갈 수 있었으면 좋겠습니다.
마지막으로 언어학 및 IT 분야 전반에 대한 배경지식을 바탕으로 테크니컬 라이팅에 적용할 수 있는 주제를 기획해 주신 Technical Communicator 인턴 이정주(JJ)에게 특별한 감사를 전합니다.

참고 문헌

[1] 김명희, 미국의 쉬운 언어정책의 제도화와 한국에의 시사점, 한국콘텐츠학회논문지, 15(2), 242-251(2015)

[2] 류성진, 미국의 Plain Writing Act of 2010과 Federal Plain Language Guidelines of 2011에 대한 연구, 미국헌법연구, 23(3), 67-99(2012)

[3] 양민호, 알기 쉬운 공공언어 사용 인증제도에 관한 한일 대조 연구, 비교일본학(38), 267-282 (2016)

[4] 일본 사이타마현 쉬운 일본어 사용 지침(일본어 원문)

[5] 법제처, 알기 쉬운 법령 정비기준(제9판)

[6] 미국 정부 공식 사이트, 미국 PLAIN 지침

📍 테크니컬 라이팅 관련 글 더보기

✓ 기술 문서 작성 5단계

✓ 카카오 i 기술문서 사이트 여정, 그리고 벌써 한 달

✓ [KREW INSIDE] AI 서비스의 기술 문서를 책임지는 사람들, 테크니컬 라이터

✓ 언어학 관점에서의 기술문서 가독성 향상 전략