Zendesk publishes its product documentation in multiple languages, including German, Spanish, French, and more. The localization process involves downloading English articles and images using the Help Center and AWS APIs, then handing them off to a localization vendor.
Once translations are complete, the articles and images are uploaded back to the help center. This process ensures that Zendesk's documentation is accessible to a global audience.
DITA, or Darwin Information Typing Architecture, is an XML-based data model used for authoring and publishing content. Zendesk uses DITA because it allows for efficient management and publishing of large documentation sets across multiple channels…
Zendesk authors its product documentation using Oxygen XML Author, which allows for creating and updating content in DITA files. These files contain structured content without styling, which is added later through CSS in the Guide theme. When ready…
Zendesk manages its DITA files using GitHub, where writers create branches, make changes, and submit pull requests for peer review. This process ensures quality and consistency across documentation. Images are stored in Amazon S3, a scalable cloud…
Zendesk primarily uses Oxygen XML Author for DITA authoring, which provides a robust environment for creating and updating content. The tool supports features like search, validation, and XHTML transformations. For publishing, Zendesk uses the Help…
Using DITA offers several benefits for Zendesk's documentation team, including enforcing a disciplined content structure and allowing easy content reuse. DITA's XML format ensures that content is versatile and manageable, making it easy to move and…