ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • 문서 도구도 문제다.
    테크니컬 라이팅 2022. 3. 18. 11:37

    나는 워드, 프레임메이커, 마크다운(깃허브 지킬), 쓰리래빗츠, 인디자인, (주피터 노트북을 포함하여) 스핑크스, 레이텍을 사용하는 프로젝트를 한 번 이상 수행했다. 어느 것 하나 단순하지 않다.

    지킬 설정은 쉽지 않지만, 마크다운이 제일 쉽다고 말할 수 있다. 하지만 그것이 제공하는 한정적인 문서 요소들에 만족하기가 쉽지 않다. 그것의 대척점에 있는 것이 인디자인이다. 인디자인은 테크니컬 라이터가 쓸 만한 도구가 절대 아니다. 디자이너가 스타일 템플릿을 만들어줘도 그렇다. 좀 과장해서 말하자면 일러스트레이터로 문서를 만드는 느낌이다. 달리 말하자면, 테크니컬 라이터가 쓰는 도구는 마우스를 덜 쓸수록 좋다.
    쓰리래빗츠는 마크다운과 유사하면서도 많은 문서 요소들을 제공한다. 소프트웨어에 친숙하지 않은 사람들에게 (속되게 말해서 '문송'한 사람들에게) 이보다 더 쉬운 솔루션이 없다. 하지만 웹브라우저로 작성하는 것은, 주피터 노트북도 마찬가지인데, 텍스트 에디터에 비해, 특히 걸출한 VS Code에 견주면 너무 불편하다.
     
    프레임메이커를 사용해 본 것은 너무 오래 전 일이라 잘 기억나지 않지만, 테크니컬 라이터를 위해 개발된 것이라는 느낌이 들었다. 다소 비싸고 사용자가 적다 보니, 이런저런 개선과 지원이 다소 미흡한 편이 아닌가 싶다.
     
    나는 (내가 속한 회사도) 의뢰인들에게 원본 파일에 대한 언급을 피한다. 굳이 원한다면 인디자인으로 유도한다. 물론 대부분의 사람들이 워드 파일을 원한다. 이러저러한 단점들을 차치하고, 워드는 생산적이지 않다. 내가 위에서 언급한 도구들 가운데 테크니컬 라이터 입장에서, 인디자인을 제외하고, 워드가 가장 비생산적이다.
     
    최근에 끝낸 프로젝트에서는 인디자인 파일을 만들어주기로 했다. 나는 줄곧 레이텍으로 작업했고, 최종 PDF를 갖고 DTP 디자이너가 인디자인 파일을 만들었다. 조판이 중복되는 것이지만 이것이 오히려 합리적이고 생산적이다. 최악의 방식은 테크니컬 라이터와 DTP 디자이너가 프로젝트 내내 파일들을 주고받는 것이다.
     
    원본을 제공하지 않거나 인디자인 파일을 제공하기로 계약한 경우에도 많은 의뢰인들이 워드 파일을 원한다. 그러면, 더 잘 변환하는 상용 서비스들이 있는 듯하지만, 나는 아크로뱃을 이용하여 워드 파일을 만들어 전달한다. 그들도 그 워드 파일이 완벽하지 않다는 것을 알고 있다. 깨끗하게 변환되었다고 해도 그것을 편집하는 것은 쉽지 않다. 스타일들이 만들어져 있지 않기 때문이다. 스타일의 일관성을 위해 지루한 복붙을 반복해야 한다.
     
    많은 회사들이 개발자들에게 매뉴얼 작성을 맡긴다. 어느 누구도 그것이 전문적인 일이라고 생각하지 않기 때문에 그렇게 시킬 수 있고 지명된 사람도 거절할 수 없다. 10 명의 개발자가 있다면 10 명의 잠재적인 테크니컬 라이터가 있는 셈이다. 그들은 서로가 파일을 돌려가며 뜯어고쳐야 한다고 생각할 것이다. 그런 인식에서 선택할 수 있는 도구는 워드밖에 없다. 워드의 가장 큰 장점은 워드가 모든 컴퓨터에 설치되어 있다는 것이다. (파워포인트도 있네!)
     
    어떻든 개발자들이 고생해서 매뉴얼을 완성했다고 치자. 그러면 다른 이해당사자들이 그 매뉴얼을 회람하며 빨간펜 선생 노릇을 하려 할 것이다. 틀린 정보만 가려내면, 이를테면 사양 중 부정확한 수치들만 잡아내면 괜찮다. 문체까지 지적하기 시작하면, 특히 두 사람이 서로 상반된 의견을 내놓으면, 좀처럼 꺼지지 않는 화재가 되어간다. 개발자들 사이에서 기술적 문제들에 대한 이해 차이가 큰 경우도 적지 않다. 그래서 나는 높은 직급을 가진 사람이 카운터파트너가 되기를 원한다, 현실은 대부분 정반대이지만.
     
    매뉴얼 작성과 조판은 자신들도 할 수 있지만 그럴 시간이 없다는 생각을 개발자들은 버려야 한다. "돌려 보기" 문화도 타파해야 한다. 아무도 책임지지 않기 때문이다. 그리고 회사에 테크니컬 라이터의 채용을 요구해야 한다. 그런 인식의 전환은 선택지를 넓힌다. 테크니컬 라이터는 워드 말고 다른 것을 선택할 수 있다. 워드로 작성하고 인디자인 편집을 외부에 맡겨도 된다, 윗분이 돈 들어간다고 좋아하지 않겠지만. 테크니컬 라이터가 DTP 디자이너와 함께 일할 수 있는 환경은 흔하지 않다. 그래서 나는 테크니컬 라이터가 하나라도 문서 도구에 능해야 한다고 본다. 
     
    소프트웨어 쪽에서는 꽤 다양한 웹 기반의 HTML 문서 솔루션들이 사용되는 모양인데, PDF 수요가 절대적인 분야에서는 아쉽게도 선택지가 다양하지 않다. 앞에서도 말했지만, 프레임메이커가 범용적인 문서 도구로서 테크니컬 라이터에게 가장 잘 어울리는 것이라고 생각한다. PDF를 만들 수 있는, 마크다운이나 XML 기반의 도구들이 여럿 있다고 들었다. 내가 경험해본 바로는 타이포그래피 측면에서 그것들이 인디자인에 비해, 전문가의 눈이 아니면 알아차리기 어려울 정도에 불과하나, 다소 미흡하다.
     
    내게는 20 년 동안 익혔기 때문에 레이텍이 가장 좋다. 이미 손에 익은 것들이 있는 분들에게 레이텍을 권할 생각은 없다. 하지만 아직 빈 손이라면 레이텍을 시도해 보시길. 문서 도구는, 특히 당신이 테크니컬 라이터라면, 당신이 생각하는 것보다 훨씬 더 중요하다. 당신이 더 좋은 문서를 만드는 데에 그것이 도움이 될 수도 있고, 장애가 될 수도 있기 때문이다. 

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

    enable과 activate  (0) 2022.04.14
    그림 캡션에 대하여  (0) 2022.03.25
    왼쪽 또는 오른쪽  (0) 2021.09.27
    테크니컬 라이터와 일러스트레이터  (5) 2021.09.15
    육각 렌치 볼트  (0) 2021.09.14

    댓글

Designed by Tistory.