From Zero to DITA in about 60 Minutes
0 likes316 views
This document details a case study on how a major automotive manufacturer migrated its documentation to DITA, enabling the publishing of hundreds of manuals in over a dozen languages. It highlights the importance of vehicle documentation and the various challenges faced during the migration process, including tool implementation and content management. The case study also discusses the future steps for improving their publishing process and the ongoing collaboration among stakeholders.
![Author [Authors Need DITA Aware Tools]
23](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-23-320.jpg)
![Author + Review [Preview of Conditional Content]
24](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-24-320.jpg)
![Author + Review [Preview of Markets and Measurements]
25](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-25-320.jpg)
![Author + Review + Publish [Publish a Tire Warranty]
Authors see layout/design/format
Reviewers see all content in context
Publishing uses the same template
■ Single column layout
■ Multiple page PDF
■ Traditional looking portrait page
Design rich mix of content
■ TOC
■ Text
■ Images
■ Table
26](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-26-320.jpg)
![Review + Publish + Quality [Published Owner’s Manual]
Reviewers see all content in context
Publishing uses the same template
■ Now a 2 column layout
■ Multiple page PDF
■ Traditional looking landscape page
Design rich mix of content
■ Text
■ Table
27](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-27-320.jpg)
![Review + Publish [Publish a User Guide]
Reviewers see all content in context
Publishing uses the same template
■ This has a 3 column layout
■ Multiple page PDF
■ Traditional looking portrait page
Design rich mix of content
■ Text
■ Table
28](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-28-320.jpg)
![Undefined Publication Styles + Match Quality [Style Guide]
29](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-29-320.jpg)
![Publish + Quality + Onboarding + Time [Automate Templates]
Required
Delivery type
■ Must support multiple print setups
■ Images of multiple formats
■ With and without crop marks
Templates
■ Many
■ Many
■ Many
Solved by
FrameMaker and one more menu
■ Scripts
■ Moved repeated tasks into a dialog
■ Combined high-level ideas
30](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-30-320.jpg)
![Publish + Quality + Onboarding + Time [Automate Templates]
31](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-31-320.jpg)
![Review + Quality + Onboarding [Initial PDF Generation and Feedback]
32](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-32-320.jpg)
![Author + Review + Publish + Onboarding + Quality [Templates]
33](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-33-320.jpg)
![Author + Quality [Speaker Info, Author View, 2 column]
34](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-34-320.jpg)
![Review + Publish + Quality [Speaker Info, Owner’s Manual, 2 column]
35](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-35-320.jpg)
![Author + Quality [Speaker Info, Author View, 3 column]
36](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-36-320.jpg)
![Publish + Review + Quality + Time [Quick Reference, 3 column]
37](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-37-320.jpg)
![Publish + Review + Quality + Time [User Guide, 3 column]
38](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-38-320.jpg)
![Author + Publish + Review + Quality + Time + Onboarding [One Solution]
41](https://image.slidesharecdn.com/fromzerotodita-190507190525/85/From-Zero-to-DITA-in-about-60-Minutes-41-320.jpg)
From Zero to DITA in about 60 Minutes
- 1. DITA: FROM “DO I?” TO “DONE IT!” AN AUTOMOTIVE CASE STUDY THAT CAN APPLY TO ANY BUSINESS
- 2. From the outline This case study and demo showcases how documentation for one of the biggest auto manufacturers in the world was to migrated to DITA allowing for publishing of hundreds of manuals in over a dozen languages. Vehicle documentation (owner’s manuals, user guides, quick reference guides, etc) are as crucial to a car as the brakes, engine, or chassis. Without these a car is not finished, and cannot be shipped and sold. Documentation failure can cost over $100,000 per MINUTE if it results in a line being shut down. Learn about the journey and discovery of concerns, project scope definition and change, trials and tribulations of getting tools to do what was needed, and the net results. Along the way a component content management system, author tools, review processes, and much more had to be planned, tested, implemented, and supported. A mix of live demo and discussion that should be entertaining and informative. 2
- 3. Agenda for Today 3 ■ Introductions ■ Program Approach ■ Q&A
- 4. What you are in for Case study and demo ■ A major auto manufacturer’s partner uses DITA for content ■ Publishing 100s of manuals in 12+ languages using multiple templates means 1000s of combinations of output! Learn about the journey and discovery of ■ Concerns ■ Project scope definition ■ Change, trials, and tribulations Demo and discussions on a CCMS, author tools, review processes, and much more An idea of “where we are now” as well as “what we’ve learned” and “what’s around the corner” Information to help YOU on your journey to a structured solution 4
- 5. PRESENTERS Who are these guys? Why are they here? 5
- 6. Bernard Aschwanden Publishing Smarter: President Content strategist, publishing technologies expert, author, and geek-enough Certified Technical Trainer ■ DITA ■ Content management ■ Topic-based writing Society for Technical Communication (www.stc.org) ■ Past-President ■ STC Associate Fellow 6
- 7. Matthew Cristoforo MSXI : Authoring System Architect 30+ Years in the Automotive Industry 20+ years in After-Sales Publication Development New business development & acquisition Start-ups and process improvements Automations to boost efficiency and profitability of established businesses 7
- 9. The Scope “Big 3” OEM changes Owner’s Information Publication provider ■ Content Creation, Print and Fulfillment ■ Pre-Production Vehicles ■ Heavy Security Requirements ■ Legacy content migration was crucial ■ Existing Translation Library Integration ■ Large reviewer base 9
- 10. The Scope “Big 3” OEM changes Owner’s Information Publication provider ■ Content Creation, Print and Fulfillment ■ Pre-Production Vehicles ■ Heavy Security Requirements ■ Legacy content migration was crucial ■ Existing Translation Library Integration ■ Large reviewer base 10
- 11. CMS Content Development Collaborative Review Publish CompositionTranslation A 11 System Requirements
- 12. Customer Review System Requirements General Customer Requirements ■ Review System capable of managing a large reviewer community ■ Review task Delegation ■ Individual topic or whole book assignment ■ Reviewer roles ■ Conditional XML formatting based on element attribute ■ Web based & Off-line requirement ■ Supporting data upload ■ Review completion reports ■ Review closure action letter ■ Review history 12
- 13. Customer Publishing Requirements General Customer Requirements ■ Publish complex design layouts ■ Publish multichannel content ■ Reduced staff required for publishing and composition ■ Resolve conditional content on a publish ■ Denote conditional content on a preview/review ■ Publish in target language as well as bi and tri-lingual publications ■ Page count reduction 13
- 14. Owner’s Information Program 14 Owners Manual User Guide Essential Information Guide Quick Reference Guide Supplemental Information Roadside Assistant Cards Product Delivery Examples MSXI Provides digital files only to print partner
- 15. Doing the Math 15 31Vehicle Lines 15Publications 100sof Combinations 13Markets 28Languages
- 16. Visualize the volume of unique content 16 197Unique USA Publications Annually +121Unique International Publications Annually 197
- 17. ISSUES AND CONCERNS TO FACE The Case Study 17
- 18. Business Concerns ■ Resource onboarding timing ■ Matched quality ■ Short implementation time ■ No authoring/review/publishing system ■ Program scope change ■ Undefined publication style ■ Very specific review system requirements 18
- 19. System Concerns ■ Data migration ■ DITA Transformation ■ Capture publication styles and specifications ■ Author tool to create/preview/publish DITA ■ Automate publishing and composition ■ Publishing needed to be quick and server based ■ Translations and multilingual publishing ■ Time and Budget constraints 19
- 20. SOLUTION OPTIONS The Case Study 20
- 21. Before Diving In Required Want to show you specific code, but 1. The code IDs the previous vendor 2. We did capture ideas to share We won’t name the client and specific auto models and brands Solved by Making tweaks to the code 1. Changed “PrevVendorName” to “GenericOld” 2. Changed “<?PrevVendor ?>” into “<?PI ?>” We’ll tell you it’s part of the Big 3 and makes SUVs, cars, vans, and pickups 21
- 22. No Author, Review, or Publish System (next slides graphical samples) Required tools Author ■ Author friendly and DITA aware ■ Must preview conditions ■ Publish with professional layout/design Review ■ Must showcase design/layout, and markup ■ Must support commenting on specific info Publish ■ Demanding template formats ■ Tables of contents, bleeder tabs, etc Solved by Author: FrameMaker ■ Structure view, quick to learn, DITA OotB ■ Can show conditions, or even “tag” markup ■ Even the draft was publish preview friendly Review: PDF and/or AEM ■ PDF via FM retains format/layout & markup ■ Acrobat Reader allows comments Publish: FrameMaker and/or FMPS ■ Can run standalone or FMPS and AEM ■ Generated content, plus scripts for design 22
- 23. Author [Authors Need DITA Aware Tools] 23
- 24. Author + Review [Preview of Conditional Content] 24
- 25. Author + Review [Preview of Markets and Measurements] 25
- 26. Author + Review + Publish [Publish a Tire Warranty] Authors see layout/design/format Reviewers see all content in context Publishing uses the same template ■ Single column layout ■ Multiple page PDF ■ Traditional looking portrait page Design rich mix of content ■ TOC ■ Text ■ Images ■ Table 26
- 27. Review + Publish + Quality [Published Owner’s Manual] Reviewers see all content in context Publishing uses the same template ■ Now a 2 column layout ■ Multiple page PDF ■ Traditional looking landscape page Design rich mix of content ■ Text ■ Table 27
- 28. Review + Publish [Publish a User Guide] Reviewers see all content in context Publishing uses the same template ■ This has a 3 column layout ■ Multiple page PDF ■ Traditional looking portrait page Design rich mix of content ■ Text ■ Table 28
- 29. Undefined Publication Styles + Match Quality [Style Guide] 29
- 30. Publish + Quality + Onboarding + Time [Automate Templates] Required Delivery type ■ Must support multiple print setups ■ Images of multiple formats ■ With and without crop marks Templates ■ Many ■ Many ■ Many Solved by FrameMaker and one more menu ■ Scripts ■ Moved repeated tasks into a dialog ■ Combined high-level ideas 30
- 31. Publish + Quality + Onboarding + Time [Automate Templates] 31
- 32. Review + Quality + Onboarding [Initial PDF Generation and Feedback] 32
- 33. Author + Review + Publish + Onboarding + Quality [Templates] 33
- 34. Author + Quality [Speaker Info, Author View, 2 column] 34
- 35. Review + Publish + Quality [Speaker Info, Owner’s Manual, 2 column] 35
- 36. Author + Quality [Speaker Info, Author View, 3 column] 36
- 37. Publish + Review + Quality + Time [Quick Reference, 3 column] 37
- 38. Publish + Review + Quality + Time [User Guide, 3 column] 38
- 39. Live demo (as time allows) using the same fileset and templates 5/7/2019Confidential 39
- 40. TECHNICAL RESULTS The Case Study 40
- 41. Author + Publish + Review + Quality + Time + Onboarding [One Solution] 41
- 42. NEXT STEPS The Case Study 42
- 43. Next steps Next up for MSXI ■ Looking to reduce overall page count ■ Looking to address review system feedback ■ Address conditions utilizing a holistic approach Next up for Publishing Smarter ■ Continue to work with our customers and with Adobe to improve products ■ Find ways to work with the MSXI team on the next project they get ■ Develop ongoing partnerships with companies (DITA, CS, CM, CCMS, etc) 43
- 44. Next steps Next up for Adobe Continue to develop DITA support Deeper connection of FMPS and AEM Next up for you, the attendee! Further questions ■ Ask in the session ■ Follow up with us directly Email [email protected] Email [email protected] 44
- 46. What we’ve discussed Case study and demo ■ A major auto manufacturer’s partner uses DITA for content ■ Publishing 100s of manuals in 12+ languages using multiple templates means 1000s of combinations of output! Learn about the journey and discovery of ■ Concerns ■ Project scope definition ■ Change, trials, and tribulations Demo and discussions on a CCMS, author tools, review processes, and much more An idea of “where we are now” as well as “what we’ve learned” and “what’s around the corner” Information to help YOU on your journey to a structured solution 46
- 47. Questions (and more questions) As time allows we are happy to address questions you may have If we run out of time, visit the Adobe booth 47
- 48. Contact information Bernard Aschwanden 905 833 8448 [email protected] www.publishingsmarter.com Matthew Cristoforo 248 687 7042 [email protected] www.msxi.com Confidential 48