Lessons Learned in DITA-OT Migration to Version 3.5
Migration project details for an IT hardware company with focus on DITA-OT plugin migration, element reusability, and more.
Download Presentation
Please find below an Image/Link to download the presentation.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.
You are allowed to download the files provided on this website for personal or commercial use, subject to the condition that they are used lawfully. All files are the property of their respective owners.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.
E N D
Presentation Transcript
DITA-OT Day, 11 February 2024 DITA-OT Day, 11 February 2024 LESSONS LEARNED MIGRATION FROM DITA-OT1.7 TO DITA-OT3.5
DITA-OT Day, 11 February 2024 INTRODUCTION Amit is a DITA-XML enthusiast, and his company, Metapercept, offers end-to-end DITA-XML implementation, information architecture, content migration, authoring, and consulting services and solutions to global clients. Until now, Amit has provided basic and advanced DITA-XML training to more than 700 technical writers and 80 companies. Amit Siddhartha, Founder and CEO 2
DITA-OT Day, 11 February 2024 ABOUT THE PROJECT The client is an imminent IT hardware manufacturing company with over 100 hardware products massive volume of installation, service, and maintenance manuals with 22 product categories 100 hardware products and a 22 product categories. The key objective in migrating to a higher version of DITA-OT was the implementation of a new DITA CCMS and Offline Publishing. Our focus areas include plugin migration, element reusability, metadata structuring, and adaptation of default DITA-OT functionalities 3
DITA-OT Day, 11 February 2024 JOURNEY, WE WENT THROUGH 4
DITA-OT Day, 11 February 2024 PRE-MIGRATION ASSESSMENT Evaluate the existing DITA-OT environment Identify potential challenges and areas for improvement Conduct a thorough analysis of the current system Determine the scope and objectives of the migration Define the timeline and resources required Identify key stakeholders and their roles Develop a comprehensive migration plan 5
DITA-OT Day, 11 February 2024 PLANNING AND PREPARATION Create a detailed migration plan Identify the scope and objectives of the migration Assess the current DITA-OT environment Determine the required resources and skill sets Define the timeline and milestones Establish communication channels and stakeholders Develop a risk management plan Conduct training and knowledge transfer sessions 6
DITA-OT Day, 11 February 2024 PLUGIN MIGRATION Architecture Analysis Architecture Analysis - - Analyze the existing elements, attributes, and content types in the DITA-OT to identify potential issues or incompatibilities. Element Mapping Element Mapping - - Map the elements and the corresponding attributes from existing DITA-OT to the DITA-OT3.5. Metadata Validation Metadata Validation - - Validate the migrated plugins in DITA-OT3.5 with source metadata to ensure accuracy and completeness. 7
DITA-OT Day, 11 February 2024 TESTING AND VALIDATION Testing Testing - Test the migrated plugins to ensure they are rendering correctly as expected. Validation Validation Validate the plugins against the original DITA-OT version to ensure no discrepancies. User Acceptance User Acceptance - Conduct user acceptance testing and make any necessary adjustments. Regression Regression - Perform regression testing to ensure optimal performance. 8
DITA-OT Day, 11 February 2024 DEPLOYMENT AND POST-MIGRATION SUPPORT Deployment Deployment Deploy to the production environment. Include system environment DITA-OT configuration to ensure necessary dependencies are in place. Post Post- -migration Support migration Support Address issues or concerns that may arise. Troubleshoot any migration-related problems. Provide guidance whenever needed. 9
DITA-OT Day, 11 February 2024 WHAT WENT WRONG? Compatibility Issues Compatibility Issues One size fits all One size fits all - - This didn t work for us This didn t work for us. Table width, attachments inside the topics, tables, heading levels, and more. The differences in the two versions required modifications to the existing codebase and customization. Plugin Compatibility Plugin Compatibility More than 22 Plugins and Extensions used in the existing version were incompatible with DITA-OT3.5. Heavily specialized DITA-OT required custom development to get in-line with DITA-OT3.5. Learning Curve Learning Curve The migration process required new features and changes in DITA-OT3.5. Less time for training and upskilling to ensure a smooth migration. Content Format Challenges Content Format Challenges Existing content in DITA as well as Markdown formats. 10
DITA-OT Day, 11 February 2024 LESSONS LEARNED Communication and Stakeholder Engagement Communication and Stakeholder Engagement Testing and Validation Testing and Validation Create awareness and maintain open and transparent communication. Conduct extensive pre-migration testing to understand the existing publishing process. Involve key stakeholders in decision-making concerns and feedback. Validate all output formats and expected results to avoid discrepancies. Documentation and Knowledge Sharing Documentation and Knowledge Sharing Planning Phase Planning Phase Document the migration process, including challenges faced and solutions implemented. Take more time to learn the source and have a detailed migration plan. Set best practices with the team to facilitate future migrations. Set clear goals, timelines, and resource allocation. Never Proceed Without A Sign Never Proceed Without A Sign- -Off Off 11
DITA-OT Day, 11 February 2024 THANK YOU! Let s Connect Let s Connect Email: asiddhartha@metapercept.com LinkedIn: https://www.linkedin.com/in/amit- siddhartha-28a7b38/ Website: https://metapercept.com 12
