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.

Managing Technical Content in an Enterprise XML Authoring Environment


Published on

For DocTrain East 2008

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

Managing Technical Content in an Enterprise XML Authoring Environment

  1. 1. Managing Technical Content in an Enterprise XML Authoring Environment Paul Masalsky Software Engineering Manager, EMC
  2. 2. Myths about moving to XML <ul><li>“ Documentation’s business role doesn’t change with XML authoring.” </li></ul><ul><li>“ I converted a document to XML. Therefore I conquered XML authoring.” </li></ul><ul><li>“ Technical doc deliverables can satisfy customers.” </li></ul><ul><li>“ XML is SEXY .” </li></ul>
  3. 3. About EMC <ul><li>2007 revenue: $12.7B </li></ul><ul><ul><li>1.4B R&D investment </li></ul></ul><ul><li>Employees: ~41,000 </li></ul><ul><ul><li>15,000 outside the US </li></ul></ul><ul><li>4 major business units </li></ul><ul><ul><li>Information storage </li></ul></ul><ul><ul><li>Content management/archiving </li></ul></ul><ul><ul><li>RSA information security </li></ul></ul><ul><ul><li>VMWare virtual infrastructure </li></ul></ul>EMC AND BUSINESS UNITS
  4. 4. About EMC: Future of digital information <ul><li>World: 161 exabytes created ( 2006) 3 million times more than all words in all books ever written </li></ul><ul><li>988 exabytes will be created in 2010 </li></ul><ul><li>“ I’m sorry, I meant… 100 billion dollars.” </li></ul><ul><li>1 gigabyte = Beethoven’s 5th Symphony </li></ul><ul><li>1 terabyte = All x-rays in a large hospital </li></ul><ul><li>1 petabyte = Half all US academic research library content </li></ul><ul><li>5 exabytes = All the words people have ever spoken </li></ul><ul><li>1 zetabyte = All grains of sand on all beaches in the world </li></ul>2.0 billion 1.6 billion Email boxes 1.3 billion 800 million Broadband internet users 26 billion 3 billion Digital music downloads 200+ 100 Digital images 300+ billion 150 billion Digital cameras 2010 2006
  5. 5. EMC structured authoring objectives <ul><li>Cost reduction </li></ul><ul><ul><li>Translation: .17 to .47 per word </li></ul></ul><ul><ul><li>Average help system: 250 words, 1000 help topics, * .32 = $80,000 </li></ul></ul><ul><li>People: Focus on content </li></ul><ul><li>Accelerated time-to-market </li></ul><ul><li>Processes: Standardize for review/approval, translation, etc. </li></ul><ul><li>Tools: Standardize on one set of tools and “eat our own dog food” </li></ul><ul><li>Branding: Re-brand content from OEMs, vendors, partners </li></ul><ul><li>Consistency: Content structure, style, look/feel </li></ul><ul><li>Dynamic content generation </li></ul><ul><li>Reuse </li></ul><ul><li>Improved customer experience </li></ul><ul><li>Simultaneous shipment </li></ul>
  6. 6. EMC’s UPD (dynamic publishing application)
  7. 7. Enterprise XML authoring environment EMC Enterprise Structured Authoring (ESA) Multiple Output Types Multiple Doc Types Specs User Guides Training Collateral Authors/Subject Matter Experts Designers Web/HTML Print/PDF Handheld/ Wireless CD-ROM Translation Localization Conversion CMS Automated Assembly and Publishing Server
  8. 8. DITA to the rescue <ul><li>Darwin: Allows for evolution of content types through inheritance and specialization. </li></ul><ul><li>Information Typing: Provides an information architecture for technical documents with base topic types of Concept, Task, and Reference. </li></ul><ul><li>Architecture: A model for extension of both design and processes. </li></ul>Sources: , Dr. JoAnn Hackos, CIDM
  9. 9. EMC DITA object types emc_glossary emc_task api_reference cli_reference param_reference msg_reference DITA_Map Bookmap Release_Notes Map topic task concept reference
  10. 10. DITA advantages <ul><li>Information managed as chunks </li></ul><ul><li>Increased usability and consistency of information </li></ul><ul><li>Content single sourced to output formats </li></ul><ul><li>Increased reuse potential </li></ul><ul><li>Specialization allows for evolution of object model </li></ul><ul><li>Chunking allows for localization cost reduction </li></ul>
  11. 11. Preparing to convert docs to DITA <ul><li>Update Frame and RoboHelp styles </li></ul><ul><li>Rewrite unstructured content to fit information architecture </li></ul><ul><li>Identify areas for potential reuse and single sourcing </li></ul><ul><li>Evaluate conversion software </li></ul><ul><li>Consider creating custom scripts (EMC uses Mif2go, custom XSLT) </li></ul>FRAME STYLES <ul><li>Heading2Task </li></ul><ul><li>Heading2Task_EMC </li></ul><ul><li>Heading2Concept </li></ul><ul><li>Heading2Concept_Glossary </li></ul><ul><li>Heading2Reference </li></ul><ul><li>Heading2Reference_API </li></ul><ul><li>Heading2Reference_CLI </li></ul><ul><li>Heading2Reference_Error_Message </li></ul><ul><li>Heading2Reference_Parameters </li></ul><ul><li>Heading3Task </li></ul><ul><li>Heading3Task_EMC </li></ul><ul><li>Heading3Concept </li></ul><ul><li>Heading3Concept_Glossary </li></ul><ul><li>Heading3Reference </li></ul><ul><li>Heading3Reference_API </li></ul><ul><li>Heading3Reference_CLI </li></ul><ul><li>Heading3Reference_Error_Message </li></ul><ul><li>Heading3Reference_Parametersz </li></ul>
  12. 12. Authoring in ESA
  13. 13. Importing content into the CMS CMS Interface
  14. 14. Client authoring with DITA and a CMS <ul><li>Checkin and checkout DITA source content </li></ul><ul><li>Preview documents locally (via DITA maps) </li></ul><ul><li>Search the CMS content repository </li></ul><ul><li>Insert links and references </li></ul><ul><li>Create new DITA topics (with specializations) </li></ul><ul><li>Publish DITA content: </li></ul><ul><ul><li>Render PDF, HTML, Javahelp, WinHelp, RTF, PS </li></ul></ul><ul><ul><li>XSL, XSL/FO style sheets </li></ul></ul><ul><ul><li>CTS integration </li></ul></ul><ul><ul><li>Support for profiling </li></ul></ul>
  15. 15. Updating DITA maps XMetaL map editor
  16. 16. Updating DITA topics Checking in an object
  17. 17. Linking to DITA content Inserting a cross reference
  18. 18. Inserting DITA references Inserting content references, reusable components
  19. 19. Publishing documents Transforming to PDF or help
  20. 20. Sample PDF output
  21. 21. Sample Webhelp output
  22. 22. Localization workflow
  23. 23. Getting started EMC RapidDeploy Fully integrates XML-based, single-source publishing, designed to be operational and delivering ROI in six weeks . <ul><li>Requirements specification and design </li></ul><ul><li>Installation and configuration </li></ul><ul><li>Testing </li></ul><ul><li>Knowledge transfer </li></ul><ul><li>Project management </li></ul><ul><li>Production deployment </li></ul>