Zendeskの一般向け製品ドキュメントはすべて、このZendeskヘルプセンターで公開されています。Zendeskのほとんどのチームはヘルプセンターで直接コンテンツを作成していますが、ドキュメントチームはオフラインでDITAソースファイルを使用して製品ドキュメントを作成、管理しています。DITAとはDocument Information Typing Architectureの略で、コンテンツを作成して公開するためにXMLを利用するデータモデルです。
この記事では、次のトピックについて説明します。
DITAを活用する理由
DITAは、大量のドキュメントを作成し、管理するための業界標準です。techwhirl.comのJacquie Samuels氏は、DITAが解決しようとしている問題を次のように説明しています。
Word、メール、PowerPoint、WordPress、HTML、InDesign、FrameMakerなどのフォーマットでコンテンツを書くのは、石版に文字を刻むようなものです。コンテンツは、本質的にそのフォーマットから抜け出せなくなり、処理しづらくなります。そのようなコンテンツは、ほかの目的で簡単に再利用することができず、非効率的でコストもかかります。DITAは、資産として管理できるようにコンテンツを作成、保存する方法です。XML（eXtensible Markup Language）を利用して、コンテンツをインテリジェントで汎用性が高く、管理しやすく、移植性の高いものにすることができます。
たとえば、DITAで作成されたコンテンツは、PDF、HTML、RTF、PowerPoint、モバイル対応のフォーマットでブランド化して公開することができます。コンテンツをファイル間でコピー&ペーストすることはありません。
（出典：What Is DITA?、TechWhirl）
Zendesk DocsチームにとってのDITAのメリットは、コンテンツとフォーマットを分けられること以外にも、以下のようなものがあります。
- コンテンツの構造について規律を守らせることができる。DITAファイルはXMLであるため、構造が無効な場合、ツールで作業ができません。
- コンテンツの移動が簡単。トピックノードを構造体のある場所から別の場所にドラッグするだけです。
- 複数の記事のコンテンツを塊にしてインポートし、再利用することができる。
- PDF形式にする機会は少ないが、PDFで公開するときはDITAファイルをソースにできる。
Zendeskで使用しているDITAオーサリングツールはOxygen XML Authorです。堅固なオーサリング環境に加え、ファイル検索、ファイル差分、変更追跡、HTML変換といった数々の機能を利用しています。他のDITAオーサリングツールとしては、Framemaker、Arbortext、XMetalなどがあります。
ヘルプセンターへの公開方法
DITAのソースファイルにあるコンテンツを作成または更新するには、Authorを使用します。公開の準備ができたら（通常は製品機能のリリースや更新と同時に）、DITAをHTMLに変換してから、手動でGuideの記事コードエディタにソースHTMLを貼り付けます。このプロセスはエレガンスに欠けていますが、それを上回る簡素性のメリットがあります。
時によって、大量の記事を短時間に更新しなければならないこともあるでしょう。たとえば、Zendeskが価格とブランドを簡素化した際、何百件もの修正記事を特定の日の午前8時（太平洋標準時）までに公開しなければなりませんでした。締め切りまでの数週間、ライターがDITAソースファイルを修正した後、すべてのDITAファイルを一括変換し、Zendesk APIを使ってヘルプセンターにアップしました。アップロードにかかった時間はわずか数分でした。
使用したバッチパブリッシングツールは、誰でも利用できるGithubのオープンソースです（https://github.com/chucknado/zpuを参照）。使い方は、こちらのドキュメント（https://github.com/chucknado/zpu/blob/master/README.md）を参照してください。
ファイルの管理方法
DITAファイルはGoogle Team Driveに保存され、各ライターのコンピュータと自動的に同期されます。ライターは最新版を常に手元に置いておくことができます。あるライターが記事の変更を保存すると、Team Driveの同期により、その変更はすぐに他のライターのコンピューターに反映されます。また、Team Driveは過去30日間の変更も保存します。ここでも、プロセスをシンプルに保つことを目標としています。
また、画像はGoogle Team Driveに保存していますが、公開の際はAmazon S3のファイルサーバーにアップロードしています。記事中の画像はすべて、ヘルプセンターからではなく、S3からブラウザにダウンロードされます。Amazon S3サービスを利用することで、画像の管理がより簡単になります。
地域に密着した記事の公開
Zendeskヘルプセンターのデフォルトの言語は英語です。製品ドキュメントは、ドイツ語、スペイン語、フランス語、日本語、韓国語、ブラジルポルトガル語でも公開しています。
ローカリゼーションのためのハンドオフが必要な場合は、ヘルプセンターAPIを使用して選択した英文記事をヘルプセンターからダウンロードし、HTMLファイルに書き出します。Amazon APIを使用して、Amazon S3バケットから記事の画像をダウンロードします。ファイルをパッケージ化して、翻訳会社に渡します。翻訳会社から翻訳が返されたら、ヘルプセンターAPIとAmazon APIを使って記事と画像をアップロードします。
ハンドオフファイルの管理に使用するAPIクライアントはZLO（Zendesk localization tools）と呼ばれる、ドキュメントチームが社内で作成したものです。ZLOクライアントはGithubのサイト（https://github.com/chucknado/zlo）で提供されているオープンソースです。詳細はGithubのドキュメントを参照してください。
0 コメント
サインインしてコメントを残してください。