테크니컬 라이팅의 기본 - 일관성

[혜운 김규인]

테크니컬 라이팅의 기본 - 일관성

 로잉 ・ 2025. 4. 23. 12:51

기술 문서를 만들 때 또 하나 중요한 것은 바로 일관성을 유지하는 것이다.

대표적으로 일관성을 유지해야 하는 것들의 종류는 다음과 같다.

• 단어나 문구, 기술 용어 등의 표현적 일관성

• 문서 내 or 문서 간 시각적 일관성

단어나 문구, 기술 용어 등의 표현적 일관성

용어집의 중요성

말 그대로다. 이것은 문서 뿐만 아니고 앱에서도 마찬가지인데 단어나 문구 등에서 일관성을 유지하는 것은 UX 수준을 높이 끌어내는 것과도 깊은 연관이 있다.

IoT 서비스를 제공하는 생활가전을 예로 들어보자.

제품에 붙어 있는 디스플레이에서는 'LED ON' 또는 'LED OFF' 라고 되어있는데 이를 앱이나 사용자 매뉴얼에서 표현하면서 '불'이나 '라이트'로 표현하는 경우가 있다. 이렇게 제품에서의 표현과 앱이나 매뉴얼에서의 표현이 다른 것은 UX 관점에서 그다지 좋은 것은 아니다.

그렇지만, 제품의 판매 전략에 따라 생산 비용 절감, 제품 라인업에 따른 부품의 관리적 효율성 측면 등을 고려했을 때 디스플레이에 국문인 '불'보다 영문인 'LED'를 쓰는 것이 나을 수 있다.

이런 경우, 앱이나 매뉴얼에서도 같이 'LED'라고 쓰는 것이 좋을 수도 있다. 만약 이것이 사용자 입장에서 어색하게 느껴진다면 '불'이라고 일관되게 쓰되, 이것이 제품에서는 'LED'라는 텍스트로 쓰임을 명시해 주는 것이 필요하다.

뿐만 아니라, 'Touch ~'라는 동사를 사용했으면 같은 방식의 동작에서는 'Touch'를 사용해야 한다. 'Tab ~'이라면 'Tab'을 사용하는 것이 좋다.

또 다른 예로, '나사를 조이다'라는 표현을 볼 수가 있다.

특히 제조 회사에서 제품의 나사를 조립하거나 푸는 과정에 대해 표현할 때 'screw'를 명사와 동사로 혼용해서 사용하는 경우가 종종 있다. 만약 동사로 사용한다면, 'screw/unscrew'로 일관되게 사용하는 것이 좋다. 만약 명사로 쓴다면, 'tighten'과 'loosen'으로 사용하는 것이 좋다.

여담이지만 일반적으로 스크류라고 하면 볼트와 너트, 그리고 와셔 등을 한 묶음으로 보는 경향이 있다. 그렇기 때문에 스크류를 명사로 사용한다고 할 때, 단지 볼트를 지칭하기 위해 스크류를 사용하는 것은 조금 무리가 있다.

또, 문서 내에서 표현을 능동형으로 사용하는 추세임에 따라 능동형으로 표현하되, 1인칭 능동인지 3인칭 능동인지 정하여 이를 일관되게 표현하는 것도 필요하다.

문서 내 or 문서 간 시각적 일관성

시각적 일관성에는 두 종류가 있는데 바로 문서 내에서의 일관성과 문서 간의 일관성이다.

전자는 쉽게 이야기해서 웹 프론트엔드 개발자라면 반드시 알아야 할 CSS라고 생각하면 된다. 제목, 부제목, 본문 등을 어떤 폰트로 크기와 컬러는 얼마로 할지, 위 아래 여백은 얼마나 줄지 등등..

글자, 문단의 서식을 정하는 것 뿐만 아니라 그림 역시 실사진을 넣을 것인지, 일러스트 작업을 통한 선화를 넣을 것인지, 또, 3D 렌더링 된 그림을 넣을 것인지를 정해서 처음부터 끝까지 그 일관성을 유지하는 것이 중요하다. 뿐만 아니라, 글과 그림의 배치 방식도 정해야 한다.

보통 이러한 것들을 비주얼스타일 가이드, 비주얼 템플릿 등이라 부르고 사용하는 어플리케이션에 따라 이를 적용하는 방법은 다양하다. MS 오피스를 주로 사용하는 회사라면 워드의 '스타일' 기능이나 파워포인트의 '슬라이드 마스터' 기능 등을 사용하면 되고 인디자인에서는 '마스터' 기능을 사용하면 된다.

여담이지만 요즘엔 그냥 온라인 플랫폼이 가장 편한 것 같다는 생각이 든다. 마크다운(MarkDown)을 지원하는 플랫폼에서 작업을 하는게 이래저래 그냥 마음이 편하다는...

이 시각적인 스타일에 대한 기준이 있고 없고는 문서를 만드는 과정에서 문서 담당자의 생산성과 효율성에서도 큰 차이가 나지만 사용자 입장에서 가독성도 향상될 뿐만 아니라 문서를 통한 브랜드 아이덴티티를 강조하는데도 큰 도움이 된다.

브랜드 아이덴티티는 요즘 브랜드 경험 (Brand eXperience)라고 하여 BX라고 많이들 부른다. 분명히 서로 다른 종류의 문서임에도 불구하고 사람들이 보기에 이 문서는 왠지 같은 회사에서 나온 문서라는 것이 느껴져야 한다. 회사마다 CI가 있으니 이 CI를 잘 활용하여 문서의 컬러와 디자인을 하는 것이 BX를 높일 수 있는 방법이다.

사실 국내 제조업에서는 이 BX에 관해 큰 관심이 없다. 대부분 '그런게 뭐 중요하냐' '실제로 제품이 얼마나 좋은지 그게 중요하지'라고들 한다. 뭐 틀린 말은 아니다. '빛좋은 개살구', '속빈 강정'이라는 우리말이 괜히 있겠나. 그런데 그렇다고 한다면 실 제품은 얼마나 성능이 좋고 타사 대비 얼마나 경쟁력이 있는가라고 묻는 다면 또 그건 그거대로 할 말이 없어지는게 현실. 그렇다면 차라리 눈에 보여지는 겉 포장이라도 신경을 좀 쓰자라는 것이 내 지론이다. 결과적으로 신경을 쓴 회사들과 쓰지 않는 회사들을 나란히 두고 비교해 보면 문서라도 잘 만든 쪽에 먼저 손이 가게 되어 있다.

한가지 주의할 점은 지나치게 '이쁜 것'에만 초점을 맞춘 나머지 가독성이 떨어지는 템플릿을 만들어내는 실수를 하고는 한다.

기술 문서의 핵심은 '이쁨'이 아니고 '가독성'과 '이해도'다. 앞서 언급한 UX도 BX도 모두 이 두가지를 전제로 했을 때 높아지는 것이다. 그리고 테크니컬 라이터가 그저 문서를 이쁘게만 만드는 것이 목적이라면 굳이 '테크니컬'이라고 할 필요가 있을까. 오히려 '도큐먼트 디자이너'가 더 어울리지 않을까.

​출처

​https://blog.naver.com/roro-husband/223843707139

[출처] 테크니컬 라이팅의 기본 - 일관성|작성자 로잉