Zendesk에 대해 일반 대중이 사용하는 모든 제품 문서는 이 Zendesk 헬프 센터에 게시됩니다. Zendesk에서 대부분의 다른 팀은 헬프 센터에서 직접 콘텐츠를 만드는 반면, 문서 팀은 DITA(Document Information Typing Architecture) 소스 파일에서 오프라인으로 제품 문서를 만들어 유지합니다. DITA는 문서 작성 및 게시에 사용되는 XML 기반 데이터 모델입니다.
이 문서에서 다루는 주제는 다음과 같습니다.
DITA를 사용해야 하는 이유
DITA는 대량의 문서를 만들고 유지할 수 있는 산업 표준 모델입니다. techwhirl.com에 근무하는 Jacquie Samuels는 본인의 회사에서 해결해야 할 문제점을 다음과 같이 설명합니다.
Word, 이메일, PowerPoint, WordPress, HTML, InDesign, FrameMaker 또는 기타 다른 형식으로 콘텐츠를 작성하는 것은 바위에 글을 새기는 것과 같습니다. 그러면 형식에 얽매이게 되어 의미가 없는 콘텐츠가 됩니다. 의미가 없는 콘텐츠는 다시 활용하거나 다용도로 사용할 수 없기 때문에 비효율적이며 비용도 많이 듭니다.DITA는 콘텐츠를 작성하고 보관할 수 있는 방법으로서 회사의 자산처럼 관리할 수 있습니다. DITA는 XML(eXtensible Markup Language)을 활용해서 지능형, 다용도, 관리 및 이동 가능한 콘텐츠를 만들 수 있습니다.
예를 들어 DITA를 통해 작성하는 콘텐츠는 여러 파일에서 복사하여 붙여넣지 않고도 PDF, HTML, RTF, PowerPoint 및 모든 모바일 형식으로 게시하고 완벽하게 브랜드 지정할 수 있습니다.
(출처: TechWhirl의 DITA란?)
콘텐츠 형식과 관련된 장점 외에도, DITA를 통해 Zendesk 문서 팀이 얻을 수 있는 이점은 다음과 같습니다.
- 콘텐츠 구조에 대해 보다 잘 파악할 수 있습니다. DITA 파일은 XML입니다. 따라서 구조가 잘못되면 DITA를 사용해도 아무 것도 할 수 없게 됩니다.
- 콘텐츠를 쉽게 이동할 수 있습니다. 주제 노드를 드래그하면 콘텐츠 구조 내에서 쉽게 옮길 수 있습니다.
- 여러 문서에서 일정량의 콘텐츠를 가져와서 콘텐츠를 다시 사용할 수 있습니다.
- PDF를 자주 게시하지는 않지만 PDF를 게시하는 경우에는 DITA 소스 파일을 사용합니다.
Zendesk 문서 팀에서 사용하는 DITA 작성 툴은 Oxygen XML Author입니다. 견고한 작성 환경 외에도 파일 검색, 파일 차이점, 변경 추적 및 HTML 변환을 비롯한 다수의 기능을 활용할 수 있습니다. 기타 몇 가지 DITA 작성 툴로는 Framemaker, Arbortext 및 XMetal 등이 있습니다.
Zendesk 문서 팀이 헬프 센터에 문서를 게시하는 방식
Zendesk 문서 팀은 Oxygen XML Author를 사용해서 DITA 소스 파일로 콘텐츠를 만들거나 업데이트합니다. 일반적으로 제품 기능이 출시되거나 업데이트되어 문서를 게시할 준비가 되면 DITA를 HTML로 변환한 다음 소스 HTML을 Guide의 문서 코드 편집기에 수동으로 붙여넣습니다. 이 프로세스가 세련되지는 않지만 매우 간단하다는 장점이 있습니다.
때때로 짧은 기간 내에 많은 문서를 업데이트해야 하는 경우가 있습니다. 예를 들어 Zendesk에서 가격 및 브랜딩을 단순화했을 때 수백 개의 개정된 문서가 특정 날짜의 오전 8시(태평양 표준시)에 게시되어야 했습니다. 마감일을 앞두고, 작성자는 DITA 소스 파일을 업데이트했고 저희는 Zendesk API를 사용해서 파일을 일괄 변환하여 헬프 센터에 게시했습니다. 불과 몇 분 만에 모든 문서를 게시할 수 있었습니다.
Zendesk 문서 팀에서 사용한 일괄 게시 툴은 누구나 이용할 수 있는 Github의 오픈 소스입니다. https://github.com/chucknado/zpu를 참조하세요. 이 툴 사용 방법에 대한 안내는 https://github.com/chucknado/zpu/blob/master/README.md에 있는 추가 정보를 참조하세요.
Zendesk 문서 팀이 파일을 관리하는 방식
Zendesk 문서 팀은 Google 팀 드라이브에 DITA 파일을 보관하며, 이 드라이브에서는 각 작성자의 컴퓨터에 파일을 자동으로 동기화합니다. 따라서 작성자는 항상 최신 버전의 파일을 손쉽게 이용할 수 있습니다. 작성자 한 사람이 문서 변경 내용을 저장하면 이 변경 내용은 팀 드라이브 동기화 기능을 통해 다른 작성자의 컴퓨터에 즉시 적용됩니다. 또한 팀 드라이브에는 지난 30일 동안의 모든 변경 내용이 유지됩니다. 다시 한번 강조하지만, 문서 팀의 목표는 프로세스를 간편하게 유지하는 것입니다.
Google 팀 드라이브에 이미지도 보관하지만 Amazon S3 파일 서버에 업로드하여 일반에게 공개하고 있습니다. 문서의 모든 이미지는 헬프 센터가 아닌 S3에서 사용자의 브라우저로 다운로드됩니다. Amazon S3 서비스를 사용하면 이미지를 보다 간편하게 관리할 수 있습니다.
Zendesk 문서 팀이 현지화된 문서를 게시하는 방식
헬프 센터의 기본 언어는 영어이지만 독일어, 스페인어, 프랑스어, 일본어, 한국어 및 포르투갈어(브라질)로도 제품 문서를 게시합니다.
현지화 작업 핸드오프가 예정되어 있으면, Zendesk 문서 팀은 헬프 센터 API를 사용해서 영어로 된 해당 문서를 헬프 센터에서 다운로드하고 이 문서를 HTML 파일로 작성합니다. 문서 이미지는 Amazon API를 사용해서 Amazon S3 버킷에서 다운로드합니다. 이 파일들을 패키지로 묶어 현지화 담당 공급업체에게 전달합니다. 이 공급업체가 번역된 문서를 Zendesk 문서 팀에 다시 보내면, 문서 팀은 헬프 센터 API와 Amazon API를 사용해서 문서와 이미지를 업로드합니다.
Zendesk 문서 팀이 핸드오프 파일을 관리하는 데 사용하는 API 클라이언트를 ZLO(Zendesk 현지화 툴)라고 하며 이 툴은 문서 팀 내부에서 만든 것입니다. ZLO 클라이언트는 Github(https://github.com/chucknado/zlo)에서 다운로드할 수 있는 오픈 소스입니다. 자세한 내용은 Github의 문서를 참조하세요.
0 댓글
댓글을 남기려면 로그인하세요.