ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • 친절한 듯 불친절한 설명서
    테크니컬 라이팅 2022. 4. 28. 15:47

    M사의 I 시스템이 H사의 제품에 포함된다. I 시스템의 아주 많은 화면에서 "매뉴얼"이라는 하위 메뉴가 제공된다. 그 메뉴를 선택하면 QR 코드가 나타난다. 스마트폰으로 QR 코드를 찍으면 웹 페이지가 열린다. 그 웹 페이지에, I 시스템에 대한 매뉴얼의 일부인데, 현재 화면에 대한 설명이 들어 있다.

    이것이 매력적인 발상인가? 많은 사람들에게 그렇게 보일 것 같다. 그런데 이 접근에서 종래의 전제를 바꾸어야 한다는 압박이 자연스레 생긴다. 누구도 사용자들이 설명서를 처음부터 차례대로 읽는다고 가정하지 않는다. 그래도 우리는 그렇게 전제한다. 이를테면 스마트폰으로 음악 스트리밍 서비스를 이용하는 방법에 대한 설명에서 데이터 통신이나 와이파이에 대한 설정을 언급하지는 않는다. 그것은 이미 적절하게 준비되어 있다고 가정한다. 하지만 설명서의 특정 페이지를 곧장 보여주는 방식을 취하다 보니, 게다가 그것이 웹 페이지이다 보니, 선결 조건들에 대한 언급이 필수적이라는 생각에 매이게 된다. 달리 말해, "와이파이 설정에 대해 XX를 보십시오" 따위의 문장을 필요 이상으로 많은 페이지에 반복적으로 집어넣어야 할 것 같다. 거기까지는 양보할 수 있다.

    더 심각한 문제가 기다리고 있다. H사는 상이한 하드웨어 옵션들로 이루어진 매우 다양한 제품군을 갖고 있다. 하드웨어옵션들이 달라진다고 해서 다양한 버전의 소프트웨어를 만들 필요가 없다. 사양에 따라 특정 기능들을 꺼버리면 그만이기 때문이다. 하지만 특정 화면에서 특정 URL에 대한 QR 코드를 포함하는 것이 생각보다 큰 걸림돌이다. 그것은 제품마다 다른 설명서를 소프트웨어에 탑재하는 것과 다를 바 없다. 단지 설명서 때문에 수십 버전의 소프트웨어를 만들 수는 없지 않은가?

    그들은 (H사인지 M사인지 모르겠으나) 문제를 단순화하는 결정을 내린다. 모든 제품에 대응할 수 있는 설명서를 만들기로 한 것이다. H사의 제품이 아무리 많아져도 사용자들이 보는 설명서는 동일한 하나이다. 이제 우리는 "제품의 사양에 따라 이것이 가능하지 않을 수 있다"거나 "제품의 사양에 따라 이 버튼의 형상이나 위치가 다를 수 있다"는 따위의 문장들을 거의 모든 단락에 삽입해야 한다. I 시스템의 소프트웨어도 자동으로 그리고 수동으로 업데이트할 수 있다. 하지만 오래된 버전의 사용자들을 위해서 이미 대체되어 더 이상 사용되지 않는 기능들에 대한 설명을 유지해야 한다. 설명서가 하나이기 때문이다.

    이렇게 만들어진 설명서가 사용자들에게 친절한 것일까? QR 코드를 찍어 열린 페이지에서 설명하는 것 가운데 절반 가까이가 자신이 갖고 있는 제품과 무관한데도? 

    QR 코드를 이용하여 특정 페이지로 연결되게 하는 한, 다시 말해 그 "매뉴얼"이라는 하위 메뉴가 유지되는 한, 이 문서화 정책 아래에서 개선할 수 있는 것은 거의 없다. 세월이 흐를수록 이 방식이 당연한 것이라는 인식이 더욱 굳어져서, 나중에 누군가 폐기하자고 주장하면 아주 강한 저항에 부딪칠 것이다. "아니, 그럼 제품마다 매뉴얼을 따로 만들자는 말이야 ? 정신이 나간 거 아냐?" 

    * * *

    아이폰도 모델이 여럿이지만 하나의 설명서만 제공하는 제품처럼 보인다. 하지만 애플은 iOS 버전에 따라 네 가지 설명서를 제공한다. 게다가 모델들 사이에 차이점들이 많지 않아서 읽기에 거의 전혀 불편하지 않다.

    '테크니컬 라이팅' 카테고리의 다른 글

    모든 것들을 가리킬 때 the  (0) 2022.05.19
    등록과 register  (0) 2022.05.10
    enable과 activate  (0) 2022.04.14
    그림 캡션에 대하여  (0) 2022.03.25
    문서 도구도 문제다.  (2) 2022.03.18

    댓글

Designed by Tistory.