ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • 문서들은 텍스트 포맷으로 작성되어야 한다.
    테크니컬 라이팅 2023. 11. 2. 10:03

    함께 퇴근하던 동료가 내게 물었다

    "고객이 어떤 내용을 추가해달라고 할 때, 마땅한 자리를 찾기 어려울 때 짜증나지 않아요?"

    전혀. 하지만 그녀가 왜 그렇게 말하는지 이해한다. 나는 레이텍을 사용하고 그녀는 워드를 사용한다. 워드 파일을 납품하는지는 모르겠다. 대개의 경우 인디자인으로 조판하여 납품한다. 인디자인은 테크니컬 라이터가 쓸 만한 도구가 아니다. 내가 설령, 그럴  생각이 전혀 없지만, 능숙하게 다룰 수 있다고 해도, 인디자인은 최악의 선택지이다. 모든 위지윅 포맷이 테크니컬 라이터에게 나쁘다. 작성 중인 문서의 구조를 크게 바꾸기가 매우 성가시기 때문이다.

    나는 수시로 바꾼다, 구조도, 용어도, 표현도. 질의와 의견도 내키는 대로 추가한다. 테크니컬 라이터는 그렇게 할 수 있어야 한다. 왜냐하면 잘 알지 못하는 것을 배워가며 작성하기 때문이다. 위지윅 프로그램을 사용하면 그렇게 하기 어렵다. 그래서 덜 성의를 갖게 되고, 결과적으로 덜 좋은 문서가 만들어진다.

    어떤 마크업 언어를 사용하든 테크니컬 라이터들은 텍스트 포맷으로 문서를 작성해야 한다. MarkDown이든, LaTeX이든, AsciiDoc이든, reStructuredText이든. 테크니컬 라이터가 조판까지 책임져야 한다고 말할 수는 없지만, 디자이너와 함께 일하는 것이, 특히 고객이 초고조차 최종본의 형태로 만들어지기를 원하는 경우에는, 괴로울 만큼 비효율적이다.

    HTML과 PDF를 동시에 만들어야 할 때, 양쪽의 디자인과 효율을 모두 만족시키는 방법은 없다. 전에는 리스트럭처드텍스트를 사용하는 스핑크스가 최선이라고 생각했지만, 지금은 내게 결정권이 주어진다면 아스키독을 선택할 것 같다.

    지금은, 팀마다 고객사가 다른데, 거의 모든 팀이 DITA로 문서를 작성하고 있다. 거의 모든 레거시 문서가 인디자인으로 작성되었고, 그것이 IDML이라는 XML 포맷으로 저장될 수 있었기 때문에, HTML에 대한 요구가 생겼을 때, 우리는 XML을 불가피한 것으로 받아들였다. XML도 텍스트 포맷이다. 하지만 지난 상반기에 DITA를 갖고 작업해 보니, 다른 마크업 언어들과 달리, XML은 위지윅 포맷들 못지않게 불편하다. 여기에 일일이 나열하기 어려울 만큼 골치 아픈 많은 문제들을 안고 있다. 게다가, DITA 창시자들의 주장과 달리 DITA는 범용적으로 쓰기에 적절하지 않다. DocBook이 오히려 나을 것이다. 이제 와서 DITA 아닌 다른 것으로 바꾸는 것은 불가능하지만.

    PDF와 HTML을 동시에 만들고자 하는 것이 결코 좋은 발상이 아니라고 생각한다. 하지만 굳이 그렇게 하자고 하면, AsciiDoc이 최선이 아닐까 싶다. LaTeX 문서에서 lwarp나 또는 내가 만든 클로시 같은 방법을 이용하여 HTML을 만들어낼 수 있지만, 스핑크스나 주피터가 만들어내는 것에 비하면 조악하여 상용적 수준에서 고려할 만하지 않다. 스핑크스는 백엔드 PDF 엔진으로서 레이텍을 사용한다. 초보 사용자에게 쉽지 않은 도전인데, PDF를 만드는 데에 성공했다고 해도, 레이텍이 자랑하는 아름다움과는 거리가 멀다. HTML 지향적인 포맷에서 변환했기 때문이다.

    마크업 언어들로 레이더 차트를 만든다면  아스키독이 가운데 자리를 차지할 것 같다. XML이나 스핑크스처럼 결과물을 얻기까지 복잡한 설정이나 프로그래밍이 필요하지 않다. 그냥 PDF와 HTML을 만들어낸다. (그리고 요즘에는 테크니컬 라이터에게 필요한 경우가 없지만 Mathjax 같은 수식도 지원한다) 아스키독이 가장 합리적이라면, 다수가 선호하고 채택했어야 하지 않을까? 문제는 디자인이다. 디자인 최적화가 얼마나 가능한지 그리고 얼마나 용이한지 모르겠다. 고객사들 중 H사는 DITA를 채용했는데, 디자인 때문에 PDF 엔진으로 프레임메이커를 사용한다. HTML에 대한 요구가 있는 것도 아닌데 왜 DITA를 도입했는지 모르겠다.

    하지만 이것만은 분명하다. 사오백 종의 문서가 있는데, 그것들 모두가 사오백 페이지라고 생각해 보자. 그것들을 인디자인 같은 위지윅 프로그램을 사용하여 시의적절하게 오류 없이 작성하고 개정할 수 있을까?

    내가 아는 범위에서 테크니컬 라이터들을 고용한 제조사들은 거의 없다. 채용하고 싶어도 사람이 없다. 이런 생각을 해봤다. 대다수의 테크니컬 라이터들이 레이텍이나 아스키독을 사용할 수 있다면, 초판을 이 사람에게 맡겼다가 개정판을 다른 사람에게 맡기는 것이 가능해진다. 많은 제조사들이 인식하지 못하고 있는데, 문서 작성에는 꽤 많은 경험과 전문적 지식이 필요하다. 전문 업체나 프리랜스 테크니컬 라이터에게 맡겨서 얻는 것은 PDF나 HTML뿐이고, 그들은 그 소스 파일을 다룰 수 없다. 심지어 워드 파일도. 인디자인 파일을 받아서 갖고 있다가 다른 업체에게 넘겨주는 경우들이 수년 전에는 종종 있었는데, 내가 위에서 주장한 이유로 인디자인은 피해야 할 선택지이다.

     

     

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

    SAE J2008  (0) 2024.01.16
    테크니컬 라이팅이란  (0) 2023.12.14
    메뉴를 choose 또는 select  (0) 2023.10.26
    Documentation과 문서화  (0) 2023.07.26
    공차 중량  (0) 2023.04.17

    댓글

Designed by Tistory.