Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Doctrain Life Sciences Handling Dita Topics And Translation In A Regulated Industry Jp


Published on

Presented by Jennifer Linton & Jennifer Perkins at Documentation and Training Life Sciences, June 23-26, 2008 in Indianapolis.

Gambro BCT, a medical device manufacturer, is diving in to the next generation of technical communications. This new environment consists of topic-based XML/DITA-structured authoring, automatic publishing, and the need increase the number of language offerings to support growth in additional and merging markets. All of this is to be done while continuing to follow regulatory guidelines.

In this discussion, Jennifer Perkins, the Technical Communications Manager, and Jennifer Linton, the XML/CMS Project Manager, provide helpful tips about each phase of the document lifecycle and what to consider when moving to an XML/DITA-based environment in a regulated industry. Do you have questions about how to support an XML/DITA-based and content and translation management system environment in your industry? This talk will provide you with some helpful tools and answers for you to move forward.

After about two and a half years of attempting to move to DITA and trying different content management system approaches, Gambro BCT is finally using the open source authoring standard, a content management system, and a translation management system. This new environment, called GEM (Globalization and English Management), is the basis for many new opportunities at Gambro BCT. They will share a brief overview of the organizational structure, tools infrastructure, and the regulatory standards needed to maintain this new environment. Then they will dive into some of the details about the discussions they had to solidify this working environment. These discussions include the information model, user guide for the content management system, persona descriptions, and process and procedure guides. For example, in their discussions, they determined that the document lifecycle needed to change to encourage regulatory signoff at a more granular level to promote a translations cost savings.

The presenters will also share the benefits that they foresee with this new environment as well as some lessons learned and next steps, including implementation of this system to develop training materials.

Published in: Business, Technology
  • Be the first to comment

Doctrain Life Sciences Handling Dita Topics And Translation In A Regulated Industry Jp

  1. 1. Handling DITA Topics and Translation in a Regulated Industry Globalization and English Management Planning for the Future … soon to be known as CaridianBCT, Inc.
  2. 2. Agenda <ul><li>Background Information </li></ul><ul><li>Case Study – Problem Statement </li></ul><ul><li>The Solution </li></ul><ul><li>Preparing for the New Environment </li></ul><ul><li>Concerns, Benefits, and Lessons Learned </li></ul>
  3. 3. About CaridianBCT, Inc. <ul><li>Medical device manufacturing company </li></ul><ul><li>Specializes in the design of blood component technology </li></ul><ul><li>Global Headquarters – Colorado, USA </li></ul><ul><li>European Headquarters – Brussels, Belgium </li></ul><ul><li>APAC Headquarters – Hong Kong, China </li></ul>
  4. 4. Technical Communications Responsibilities <ul><li>Authoring and translation of </li></ul><ul><ul><li>all labels for BCT equipment: Operator’s Manuals, Instructions for Use (IFUs), kit, case, and bag labels, Tyvek disposable kit covers </li></ul></ul><ul><ul><li>service materials: service manuals, preventive maintenance procedures, schematics, installation procedures, spare parts instructions </li></ul></ul><ul><ul><li>other technical documents as requested: training materials, protocols, Standard Operating Procedures (SOPs) </li></ul></ul>
  5. 5. Regulatory Standards <ul><li>USA </li></ul><ul><li>Governed by the FDA CFR Part 801 (Code of Federal Regulations) </li></ul><ul><li>EMEA </li></ul><ul><li>MDD [Medical Device Directive (93/42/EEC)] </li></ul><ul><ul><li>Annex 1, Essential Requirements </li></ul></ul><ul><ul><ul><li>II. Requirements regarding design and construction, </li></ul></ul></ul><ul><ul><ul><ul><li>Point 13. Information Supplied by the Manufacturer </li></ul></ul></ul></ul><ul><li>Canada </li></ul><ul><li>Health Canada – Sections 21 and 23 of the Medical Devices Regulations </li></ul><ul><li>CSA (Canadian Standards Association) – Electrical Standards accepted in most countries </li></ul>
  6. 6. Regulatory Standards (cont.) <ul><li>APAC </li></ul><ul><ul><li>APAC uses IEC (International Electromechanical Commission) and ISO (International Organization for Standardization) as a baseline for their own standards. </li></ul></ul><ul><ul><li>This includes China and Japan. </li></ul></ul><ul><li>Internal </li></ul><ul><li>SOP for BCT Labeling Approval and Control </li></ul><ul><li>MDD definitions for labeling are broad enough to be applied generally to all BCT labeling. </li></ul><ul><li>Changes made on a country-by-country, region-by-region basis. </li></ul>
  7. 7. Case Study – Background Information <ul><li>As per the MDD, all labels written in source language (in our case, English) requires translation into the target languages in which the product is sold. </li></ul><ul><li>Currently, CaridianBCT sells products in <20 countries worldwide. </li></ul><ul><li>Structure, format, and approach to customer documentation can drive up costs for all English and translated deliverables. </li></ul><ul><li>CaridianBCT is tasked with reducing translation costs and increasing consistency across deliverables and product lines. </li></ul>
  8. 8. Case Study – Problem Statement <ul><li>COBE Spectra ® Apheresis System Manual </li></ul><ul><ul><li>The English version of the manual is currently a 4-volume set. </li></ul></ul><ul><ul><ul><li>Some world areas are reluctant to translate the entire set due to cost constraints. </li></ul></ul></ul><ul><ul><ul><li>Creating documents to meet requirements while remaining “usable” is a challenge! </li></ul></ul></ul><ul><ul><ul><li>Each country has specific regulations that must be met in order to sell within that country. </li></ul></ul></ul><ul><ul><li>Each country may interpret what you write differently. </li></ul></ul><ul><ul><ul><li>It is the writer’s job to ensure the regulations are met, the document is usable, concise, inexpensive to translate, and available for all countries. </li></ul></ul></ul><ul><ul><li>Creativity is limited </li></ul></ul>
  9. 9. Case Study – Interim Regulatory Solution <ul><li>Created an “abridged” version of the manual to meet specific regulations for EMEA. </li></ul><ul><li>APAC paid for translation of entire 4-volume set. </li></ul><ul><li>Abridged manual is not intended to be used as a training tool, guideline for SOPs, or for a procedural manual for the equipment. </li></ul><ul><li>Purpose - to provide a translated version of the manual in order to meet the basic regulatory and language requirements of the countries in which we intend to sell the product. </li></ul><ul><li>Each product receives the translated abridged version, plus a full manual in English. </li></ul><ul><li>Meets the regulatory requirements, while providing necessary information to the end user. </li></ul>Bottom Line: There is still a problem - this creates two different source documents to manage, review, and translate
  10. 10. Case Study – Managing the Growth <ul><li>What are we going to do about the growing number of documents created that have the exact same content? </li></ul><ul><ul><li>The number of labels increases each year, AND content must remain consistent between all different deliverables. </li></ul></ul><ul><ul><li>CaridianBCT needs to deliver both paper and electronic-based user material with the same content. </li></ul></ul><ul><ul><li>Manual updates through FrameMaker causes inconsistencies with content. </li></ul></ul><ul><ul><li>Application-based authoring systems are expensive to maintain, and translation costs over time increase exponentially. </li></ul></ul><ul><ul><li>Retranslating the same content over and over can be costly and error prone! </li></ul></ul>
  11. 11. The Solution Implementing DITA XML, Content Management, and Translation Management Globalization and English Management
  12. 12. Tools and Technologies <ul><li>DITA (topic-based) authoring </li></ul><ul><ul><li>Improves reuse </li></ul></ul><ul><ul><li>Improves time-to-market </li></ul></ul><ul><ul><li>Improves consistency in deliverables </li></ul></ul><ul><li>Content Management System </li></ul><ul><ul><li>Central storage location for all authors and departments to access </li></ul></ul><ul><li>Translation Management System </li></ul><ul><ul><li>Manages our translated content </li></ul></ul><ul><ul><li>Improves term consistency </li></ul></ul>
  13. 13. Non-Regulated vs. Regulated Environments <ul><li>Non-regulated </li></ul><ul><li>Output flexibility </li></ul><ul><ul><li>Allows for more dynamic deliverable creation and delivery options </li></ul></ul><ul><li>Quick roundtrip translations </li></ul><ul><ul><li>No ICR (in-country review) required </li></ul></ul><ul><li>Customer responsibility to retrieve needed information. </li></ul><ul><li>Regulated </li></ul><ul><li>Thorough output approval </li></ul><ul><ul><li>Every deliverable hierarchy and format must be reviewed. </li></ul></ul><ul><ul><li>Engineering Change Orders (ECOs) required. </li></ul></ul><ul><ul><li>PDF/Print needed vs. electronic delivery </li></ul></ul><ul><li>In-country review </li></ul><ul><ul><li>Complicates integrated workflows between CMS/TMS </li></ul></ul><ul><li>Proactive communication to customers </li></ul><ul><ul><li>Not only are we regulated, our customers are as well. </li></ul></ul><ul><ul><li>It is our responsibility to provide thorough documentation of changes from version to version to the customers. </li></ul></ul>Bottom Line: There are more detailed considerations required to implement a topic-based authoring and translation environment in a regulated industry
  14. 14. Preparing for the New Environment <ul><li>Because we are in a highly regulated environment, we must make sure we have crossed all our t’s and dotted all our i’s – it’s better to think about it all before it sneaks up unexpectedly. </li></ul><ul><ul><li>Identify all stakeholders </li></ul></ul><ul><ul><li>Define personas </li></ul></ul><ul><ul><li>Establish a high-level process </li></ul></ul><ul><ul><li>Develop system requirements </li></ul></ul><ul><ul><li>Create an information model and L10N style guide Document a CMS/TMS user guide </li></ul></ul><ul><ul><li>Document business process and procedures </li></ul></ul><ul><ul><li>Qualify LSPs (Language Service Providers) and establish an ICR (in-country review) process </li></ul></ul>
  15. 15. Stakeholders <ul><li>Upper Management </li></ul><ul><li>Authors </li></ul><ul><li>Localization </li></ul><ul><ul><li>Localization PMs, LSPs, Translators, In-Country Reviewers </li></ul></ul><ul><li>Reviewers (SMEs) </li></ul><ul><li>Regulatory department </li></ul><ul><ul><li>Discussions with the regulatory department to establish an approval process for individual topics </li></ul></ul>
  16. 16. Future Environment Persona Descriptions <ul><li>Identify the roles, responsibilities, and training plan for each of the internal people in the department </li></ul><ul><ul><li>Writer/Content Contributor </li></ul></ul><ul><ul><li>Editor </li></ul></ul><ul><ul><li>Production Coordinator </li></ul></ul><ul><ul><li>Reviewer/Approver </li></ul></ul><ul><ul><li>Information Architect </li></ul></ul><ul><ul><li>Tools Super User </li></ul></ul><ul><ul><li>Project Manager </li></ul></ul><ul><ul><li>Localization PMs and Coordinators </li></ul></ul>
  17. 17. CaridianBCT’s Tech Comm Future Process <ul><li>Plan/Design </li></ul><ul><ul><li>Authors create project plan specification, master topic list, and initial shell DITA Map (TOC) for review </li></ul></ul><ul><li>In Development </li></ul><ul><ul><li>Authors create topics of content (tasks, concepts, references) </li></ul></ul><ul><ul><li>Authors initiate a workflow to send groups of topics for review </li></ul></ul><ul><li>Review/Validate </li></ul><ul><ul><li>Reviewers open the task in the CMS Reviewer tool and adds comments </li></ul></ul><ul><li>Approve </li></ul><ul><ul><li>Content approvers review and approve the content at the topic level to freeze the topics before sending them for translation </li></ul></ul><ul><ul><li>The CMS records the comments and sends the information through the rest of the workflow to be produced as a deliverable </li></ul></ul>
  18. 18. CaridianBCT’s Tech Comm Future Process (cont.) <ul><li>Translate </li></ul><ul><ul><li>Send groups of topics that have changed source content to translation rather than sending the entire manual to translation again </li></ul></ul><ul><li>Assemble/Produce </li></ul><ul><ul><li>Apply stylesheets to publish output (PDF, HTML, RTF, PDA/Mobile device) </li></ul></ul><ul><li>ECO (Engineering Change Order) </li></ul><ul><ul><li>Content approvers review the document as a whole to approve the final output. Much of the content approval is complete at this stage due to the previous approve stage. This is a regulatory step to approve the final output. </li></ul></ul><ul><li>Publish/Deliver </li></ul><ul><ul><li>Send final output to the printer or web publishers group </li></ul></ul>
  19. 19. CMS/TMS System Requirements <ul><li>Infrastructure </li></ul><ul><li>System Administration </li></ul><ul><li>Customization </li></ul><ul><li>Migration Support </li></ul><ul><li>DTD support </li></ul><ul><li>CMS Repository Functionality </li></ul><ul><li>Version Control </li></ul><ul><li>Workflow </li></ul><ul><li>DITA Topic Authoring (Integration) </li></ul><ul><li>DITA Map Authoring/Creation </li></ul><ul><li>DITA Content References </li></ul><ul><li>Metadata </li></ul><ul><li>Search </li></ul><ul><li>Editing/Review </li></ul><ul><li>Linking </li></ul><ul><li>Translation/Localization support (CMS) </li></ul><ul><li>Production </li></ul><ul><li>Conditional Processing </li></ul><ul><li>Usability </li></ul><ul><li>Translation Memory / Terminology Database </li></ul>
  20. 20. Create an Information Model/L10N Styleguide <ul><li>CaridianBCT’s information model </li></ul><ul><ul><li>Information Type Definitions </li></ul></ul><ul><ul><li>Content Unit, Body Element, and Inline Element Type Definitions </li></ul></ul><ul><ul><ul><li>(Internally specific DITA Language Reference) </li></ul></ul></ul><ul><ul><li>Document Structure Element Definitions </li></ul></ul><ul><ul><ul><li>(Internally specific DITA Map Definitions) </li></ul></ul></ul><ul><ul><li>Metadata Descriptions </li></ul></ul><ul><ul><ul><li>Includes translation metadata (valid xml:lang attribute values) </li></ul></ul></ul><ul><ul><li>CMS/TMS Folder Structure Definitions </li></ul></ul><ul><ul><li>Naming Conventions Definitions </li></ul></ul><ul><ul><ul><li>Attribute values, DITA Topic file names, graphic file names, etc. </li></ul></ul></ul>
  21. 21. CMS/TMS User Guide <ul><li>CaridianBCT specific CMS procedures - documents internal business processes and workarounds when using the CMS </li></ul><ul><ul><li>Adding a content reference (CMS) </li></ul></ul><ul><ul><li>Adding metadata in the CMS (CMS) </li></ul></ul><ul><ul><li>Checking in a topic (CMS) </li></ul></ul><ul><ul><li>Checking out a topic (CMS) </li></ul></ul><ul><ul><li>Creating a map (CMS) </li></ul></ul><ul><ul><li>Producing a deliverable (CMS) </li></ul></ul><ul><ul><li>Conditionally filtering a deliverable (CMS) </li></ul></ul><ul><ul><li>Reviewing topics (CMS/TMS) </li></ul></ul><ul><ul><li>Searching the CMS repository (CMS) </li></ul></ul><ul><ul><li>Sending topics to translation (CMS/TMS) </li></ul></ul><ul><ul><li>Creating an update during a translation project (CMS/TMS) </li></ul></ul><ul><ul><li>Creating a translation project (TMS) </li></ul></ul><ul><ul><li>Searching and editing the terminology database (TMS) </li></ul></ul><ul><ul><li>Searching the translation memory (TMS) </li></ul></ul>
  22. 22. Business Process and Procedure Guides <ul><li>Documents the approach to working in a topic-based/CMS/TMS environment </li></ul><ul><ul><li>Planning a DITA project </li></ul></ul><ul><ul><ul><li>Creating a master topic list </li></ul></ul></ul><ul><ul><ul><li>Creating a project plan specification for DITA projects (Creating your DITA map shell TOC) </li></ul></ul></ul><ul><ul><li>Performing a QA on topics and deliverables ( all languages) </li></ul></ul><ul><ul><ul><li>Identifying stylesheet issues </li></ul></ul></ul><ul><ul><li>Identifying and applying conditional filtering criteria </li></ul></ul><ul><ul><li>Sending topics to SMEs for review </li></ul></ul><ul><ul><ul><li>Sending conditionally filtered information for review </li></ul></ul></ul><ul><ul><li>Approving topics for translation </li></ul></ul><ul><ul><li>Setting up DITA Maps for translation kits </li></ul></ul><ul><ul><ul><li>Sending updated topics to translation </li></ul></ul></ul><ul><ul><li>Updating the terminology database </li></ul></ul><ul><ul><li>Updating translation memory </li></ul></ul>
  23. 23. LSP Qualification and ICRs <ul><li>Qualifying LSPs ensures they know our translation technology. </li></ul><ul><li>Implementing an in-country review process promotes quality assurance. </li></ul><ul><li>Ensuring regulatory standards are met in different countries by implementing in-country reviews. </li></ul><ul><li>Changing requirements for LSPs </li></ul><ul><ul><li>Be prepared that the current LSP base does not accept the new environment and you may need to qualify/hire LSPs. </li></ul></ul>
  24. 24. So where are we now?
  25. 25. GEM Environment – Future Concerns <ul><li>Existing LSP base may resist process changes </li></ul><ul><ul><li>We found some of our LSPs did not like the improved internal management of translated content on the client side. </li></ul></ul><ul><ul><li>LSPs did not like the drop in DTP, so charged more on PM. </li></ul></ul><ul><ul><li>LSPs may start charging flat fees for projects because we are eliminating the cost of retranslating already translated content. </li></ul></ul><ul><li>ICRs performed at the topic level </li></ul><ul><ul><li>In-country reviewers need to learn to review in a topic-based context. </li></ul></ul><ul><li>Stylesheets </li></ul><ul><ul><li>We need to take an iterative approach to create our stylesheets to support multiple languages. </li></ul></ul><ul><li>CMS and TMS configuration and functionality pitfalls </li></ul><ul><ul><li>We need to anticipate enhancement requests for the tools before they cause problems during live projects </li></ul></ul><ul><ul><li>The integration of the CMS with the TMS needs extensive testing </li></ul></ul><ul><ul><li>Using new tools is hard for everyone – authors, reviewers, translators, in-country reviewers, etc. all need training (usually more than once) </li></ul></ul>
  26. 26. GEM Environment – Known Benefits <ul><li>Translation cost savings of nearly $5,500/language/deliverable </li></ul><ul><ul><li>Eliminated desktop publishing </li></ul></ul><ul><ul><li>Decreased translation costs because of TM leverage and internally managing previously-translated content </li></ul></ul><ul><ul><ul><li>PM costs reduce as well </li></ul></ul></ul><ul><li>Reuse </li></ul><ul><ul><li>Reuse content at the topic level by referencing the different topics into hierarchical maps to create deliverables. </li></ul></ul><ul><ul><li>Write once, Edit once, Review once, Translate once, Produce multiple times. </li></ul></ul><ul><ul><li>Process efficiency is greatly improved. </li></ul></ul>
  27. 27. GEM Environment – Known Benefits (cont.) <ul><li>Flexibility </li></ul><ul><ul><li>Create different types of deliverables for different audiences, locations, media (HTML vs. Print), and in many different languages </li></ul></ul><ul><ul><li>Conditional filtering - authoring and translating nearly similar content and filtering only what is needed in-house to publish specific deliverables for specific product version or audiences. </li></ul></ul><ul><li>Portability </li></ul><ul><ul><li>More than just technical documentation can use these technologies –Marketing, Training, Web Development, and other departments can use this method for creating information and keeping it consistent throughout all deliverables. </li></ul></ul>Bottom Line: In the pilot project, CaridianBCT is producing 24 deliverables from one source and one translation project because of reuse and conditional filtering and saving nearly $100,000
  28. 28. What does it all mean… <ul><li>…from a regulatory perspective? </li></ul><ul><ul><li>Consistency!!! </li></ul></ul><ul><ul><ul><li>We no longer have to update multiple sources. </li></ul></ul></ul><ul><ul><li>Eliminate manual creation of change lists </li></ul></ul><ul><ul><ul><li>We can now more easily create change lists for our regulated customers using topic and map comparison on different versions. </li></ul></ul></ul><ul><ul><li>Expanded language base </li></ul></ul><ul><ul><ul><li>Using these systems and technologies, we increase the number of languages without drastically increasing the cost. </li></ul></ul></ul><ul><ul><ul><li>If we have the deliverables available in the target language, it makes it easier to be able to sell the products in those countries. </li></ul></ul></ul>
  29. 29. Business Lessons Learned <ul><li>The transition from manual-based authoring to topic-based authoring is not just something to think about in the technical documentation department, it affects everyone in the company (reviewers, regulatory, translations, etc.) </li></ul><ul><li>Know the regulations! They drive your documentation </li></ul><ul><ul><li>Partner with the internal Regulatory department to understand how regulations are interpreted at your company. The regulations and interpretation may vary depending on the organization. </li></ul></ul><ul><li>Understand the user base and their access to technology. The users may differ depending upon which product they are using. </li></ul><ul><ul><li>For example, nurses may not be able to use electronic manuals or help systems at the patient bedside. Paper may be the best solution. </li></ul></ul><ul><ul><li>If so, try to find the best ways to deliver the paper-based documentation in the most concise manner and also offer electronic formats (reuse and flexible media output!). </li></ul></ul>
  30. 30. Technology Lessons Learned <ul><li>Until people start working in the tools, there is only so much you can do with just the concepts and theories </li></ul><ul><li>Identify a pilot project where you can test changing the content </li></ul><ul><ul><li>We couldn’t change the content too drastically to follow the DITA methodology because of increasing the workload to create a change list for regulatory requirements from our customers. </li></ul></ul><ul><ul><li>Instead of writing content to fit the DITA model and our information architecture, we are changing DITA to somewhat accommodate our content (Note: we plan to go back and revise this for the next release) </li></ul></ul><ul><li>Don’t try to test all use cases with one pilot project. </li></ul><ul><ul><li>This extends the pilot project which decreases the opportunity to demonstrate quick wins, maintain a sense of urgency, and maintain deadlines </li></ul></ul><ul><ul><li>Although we were able to test a lot with our one pilot project, there are some things that we still need to test, but must create a new project because of timeline creep. </li></ul></ul>
  31. 31. Business best practices & things to keep in mind <ul><li>Work cross-functionally to support the entire project </li></ul><ul><ul><li>Streamline the documentation group to include English development and deliverable localization team </li></ul></ul><ul><ul><ul><li>Content creation and translation are not independent processes and should be thought of as an integrated workflow </li></ul></ul></ul><ul><ul><li>Work closely with software localization team </li></ul></ul><ul><li>Engage all stakeholders in advance, including internal teams, translation suppliers, and reviewers </li></ul>
  32. 32. Technology best practices & things to keep in mind <ul><li>Implementing CMS/TMS tools gives writers more control over the content ownership </li></ul><ul><ul><li>More difficult for SMEs and reviewers to make minor changes because it could impact many different deliverables. </li></ul></ul><ul><li>Use technology to help manage content consistency and ensure compliance </li></ul>
  33. 33. Foreseeable Next Steps <ul><li>Expand the GEM environment to additional departments </li></ul><ul><ul><li>Training, Quality Management, Marketing, Service Technicians, etc. </li></ul></ul><ul><li>Performing ECO upstream at the topic level </li></ul><ul><ul><li>By ECOing our topics, then we can create deliverables in even less time. </li></ul></ul><ul><li>Identifying additional methods for delivering content to our users </li></ul><ul><ul><li>HTML/Web, PDA/Mobile devices, embedded help, CD, etc. </li></ul></ul>
  34. 34. Questions?