DITA as Interchange Format for Crowdsourcing and Acquisitions

50 %
50 %
Information about DITA as Interchange Format for Crowdsourcing and Acquisitions

Published on June 4, 2019

Author: BenColborn

Source: slideshare.net

1. DITA as Interchange Format for Crowdsourcing and Acquisitions Ben Colborn Director, Technical Publications Nutanix, San José Renée Haran, Manager, Learning Experience Design Nutanix, Durham

2. Nutanix Customer Journey Modernize IT with HCI Secureandautomateapplications,and consolidatestorage Build an Enterprise Cloud Multi-Cloud Services for Apps and Data Unifyoperationsacrosspublic and privateclouds Deliver enterpriseappsandVDI fromanysite

3. Nutanix Product Portfolio One Year Ago 4

4. Nutanix Product Portfolio Today 5

5. Pros/Cons of Approaches DITA XML DTP markdown Low barrier to entry • • Topic-oriented • ~ Separation of content and format • • Comprehensible diff ~ • Comprehensive semantics • • Reuse capabilities • ~

6. Nutanix Support Portal Customer View

7. YAML/Git Compatibility Word-to-DITA/ Sharepoint/Git Solutions/ Technical Marketing DITA/Git Product Documentation Salesforce Knowledge KB Articles Nutanix Support Portal Publishing Architecture

8. Word-to-DITA for Crowdsourcing Solving DITA issues of adoption and scale

9. In the beginning... • EDU 100% ILT model • 60-80% reuse of DITA topics • Shared repository • Mature publishing scheme • Only a few folks to manage ED U+ TP

10. Then there was Scale Hell • Shifted to eLearning + ILT • Rapid team expansion • Broke the DITA repo, mutiny • We also wanted to reuse Soln/TME content • How to repair? + :( TP

11. Use Cases Solutions/Technical Marketing 1. SMEs author documents in Word (template) 2. Editor finalizes content in Word 3. Production specialist publishes to support portal (DITA to HTML, PDF, ePUB) Technical Training/EDU 1. Trainers/SMEs author course material in Word (template) 2. Instructional designers finalize content in Word 3. Production specialist converts Word to DITA 4. Production specialist generates PDF and PPT from DITA source

12. Publishing Process DITA D4P- HTML5 JSON Portal load Word DITA D4P- HTML5 JSON Portal load Mature Word-to-DITA

13. Word-to-DITA Conversion Process Word Style-to-Tag Mapping Fixup DITA

14. Style-to-Tag Mapping for Education

15. DITA-to-PPT Transformation

16. LwDITA for Acquisitions

17. markdown • Pros: Low barrier to entry; topic-oriented; separation of content and format; comprehensible diff • Cons: Comprehensive semantics; reuse capabilities • Untold number of markdown-based static site generators available for free or low cost • The obvious choice for a startup today • Used by multiple small companies that have been acquired by Nutanix

18. Markdown- Based Legacy Site

19. Publishing Process DITA D4P- HTML5 JSON Portal load markdown DITA D4P- HTML5 JSON Portal load markdown HTML JSON Portal load Mature markdown option 1 markdown option 2

20. Prerequisites • Create a DITAMAP that references the markdown files • Modify the markdown files to conform with DITA’s more constrained information model • Install DITA OT 3.x

21. Markdown on Support Portal

22. Conclusion

23. Pros/Cons of Approaches DITA XML Word2DITA lwDITA Low barrier to entry ? ? Topic-oriented • ~ • Separation of content and format • • • Comprehensible diff • • Comprehensive semantics • ~ ~ Reuse capabilities • ~ •

24. Summary • LwDITA and W2DITA can be used as interchange formats for acquisitions and crowdsourcing (non-native DITA) • Companies with well-established DITA content practices can provide flexible interchange options for more-than-casual but less-than-professional authors • These "lightweight" options can be helpful in acquisitions and scenarios where reuse across business units/authoring groups that are otherwise siloed is needed

Add a comment