Zendesk에 대해 일반 대중이 사용하는 모든 제품 문서는 이 Zendesk 헬프 센터에 게시됩니다. Zendesk에서 대부분의 다른 팀은 헬프 센터에서 직접 콘텐츠를 만드는 반면, 문서 팀은 DITA 소스 파일에서 오프라인으로 제품 문서를 만들어 유지합니다. Darwin Information Typing Architecture를 의미하는 DITA는 콘텐츠 작성 및 게시에 사용되는 XML 기반 데이터 모델입니다. 기본적으로 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입니다. 견고한 작성 환경 외에도 검색, 유효성 검사 및 XHTML 변환을 비롯한 다수의 기능을 활용할 수 있습니다. 기타 몇 가지 DITA 작성 도구로는 Framemaker, Arbortext 및 XMetal 등이 있습니다.
Zendesk 문서 팀이 문서를 작성하고 게시하는 방식
작성자들은 Oxygen XML Author를 사용하여 DITA 파일의 콘텐츠를 만들거나 업데이트합니다. DITA는 단일 소스에서 여러 채널 게시를 허용하도록 만들어졌으므로 DITA 텍스트 파일은 어떤 스타일링도 포함하지 않으며, 구조화된 콘텐츠만 포함합니다. 웹 채널의 경우 모든 스타일링은 DITA가 아닌 외부 CSS 스타일 시트로 제공됩니다. Zendesk의 경우 모든 스타일링은 Guide 테마의 스타일 시트로 제공됩니다.
게시할 준비가 되면(보통 제품 기능이 발표되거나 업데이트되는 동시에) Author를 사용하여 DITA를 보다 엄격한 HTML 버전인 XHTML로 변환합니다. 그런 다음 헬프 센터 API를 사용하여 XHTML을 헬프 센터에 게시합니다.
버전 24부터 Oxygen XML 편집기에는 DITA 주제를 XHTML 출력에 게시하고 문서로 Zendesk 헬프 센터에 직접 업로드할 수 있는 기본 제공 변환 시나리오가 포함됩니다. XML 편집기 도움말에서 DITA 맵 게시를 참조하세요. 동영상의 경우에는 XML 편집기 도움말에서 Zendesk 헬프 센터에 콘텐츠 게시하기를 참조하세요.
때때로 짧은 기간 내에 많은 문서를 업데이트해야 하는 경우가 있습니다. 예를 들어 Zendesk에서 가격 및 브랜딩을 단순화했을 때 수백 개의 개정된 문서가 특정 날짜의 오전 8시(태평양 표준시)에 게시되어야 했습니다. 기한을 몇 주 앞두고, 작성자는 DITA 소스 파일을 업데이트했고 저희는 Author를 사용해서 파일을 일괄 변환했습니다. 그런 다음 헬프 센터 API를 사용하여 헬프 센터에 게시했습니다. 불과 몇 분 만에 모든 문서를 게시할 수 있었습니다.
Zendesk 문서 팀이 파일을 관리하는 방식
GitHub를 사용하여 DITA 파일을 관리합니다. 작성자는 문서를 만들거나 업데이트하기 전에 저장소에 브랜치를 만들고 변경 작업을 수행한 후 끌어오기 요청을 만듭니다. 끌어오기 요청은 팀의 다른 작성자가 검토합니다. 이를 통해 작성자들이 서로의 작업을 검토할 기회를 가지게 되는 이점이 있습니다.
Amazon Web Services (AWS)가 제공하는 확장 가능한 클라우드 스토리지 서비스인 Amazon S3(Amazon Simple Storage Service)에 이미지를 보관합니다. 문서의 모든 이미지는 헬프 센터가 아닌 S3에서 사용자의 브라우저로 제공됩니다. Amazon S3 서비스를 사용하면 이미지를 보다 간편하게 관리할 수 있습니다.
Zendesk 문서 팀이 현지화된 문서를 게시하는 방식
헬프 센터의 기본 언어는 영어이지만 독일어, 스페인어, 프랑스어, 일본어, 한국어, 포르투갈어(브라질), 이탈리아어 및 중국어(간체)로도 제품 문서를 게시합니다.
현지화 작업 핸드오프가 예정되어 있으면, Zendesk 문서 팀은 헬프 센터 API를 사용해서 영어로 된 해당 문서를 헬프 센터에서 다운로드하고 이 문서를 HTML 파일로 작성합니다. 문서 이미지는 Amazon AWS API를 사용해서 Amazon S3 버킷에서 다운로드합니다. HTML 파일과 이미지를 패키지화하여 현지화 공급업체에 건넵니다. 이 공급업체가 번역된 문서를 Zendesk 문서 팀에 다시 보내면, 문서 팀은 헬프 센터 API와 AWS API를 사용해서 문서와 이미지를 업로드합니다.