Recommended
Recommended
More Related Content
Similar to DITA explained to my boss, flacke
Similar to DITA explained to my boss, flacke (20)
Recently uploaded
Recently uploaded (20)
DITA explained to my boss, flacke
- 1. flacke@orange.fr 1 DITA and content reuse explained: a Case Study Marie Louise Flacke Awel-A-Ben France
- 2. flacke@orange.fr 2 ConRef? Tags? DITA 1.2? CMS ? Pilot project? Filtering?Migrating to DITA Conditional Text? Explaining content reuse to my boss…
- 4. flacke@orange.fr 4 Cost reduction? • Outsourcing (low cost countries) • Stop releasing customer documentation • Reshaping your documentation
- 5. flacke@orange.fr 5 Which (outsourcing) savings? „The truth is, no one saves 80 percent by shipping IT work to India or any other country. Few can say they save even half that. As just one example, United Technologies, is saving just over 20 percent by outsourcing to India.“ Hidden costs of outsourcing, CIO Magazine,Sept. 2003
- 7. flacke@orange.fr 7 Structuring your documentation? • Findability • Updates • Content reuse HUGE Effort…
- 8. flacke@orange.fr 8 Start to collect requirements • Invite product stakeholders • Marketing, legal, product manager, training, customer support… • List requirements
- 9. flacke@orange.fr 9 Requirement list Department Needs Documentation Marketing Pre-sales Flyer, Web page, fact sheet, video Legal Safety recommendations, legal requirements Standard & Safety message Bible? Training Training support PPT, video, manual Product management /operations End user documentation User manual, installation manual, Web, Twitter, etc
- 10. flacke@orange.fr 10 Going global? • How many countries? • How many languages?
- 11. flacke@orange.fr 11 Globalization requirements • One fits all? • Inquire with Country Managers Countries/ Regions Languages Legal requirements Europe 23 European Standards North America 2 (3?) ANSI, ISO North Africa/Middle East 3 ISO Asia (prospecting) 3 ISO
- 12. flacke@orange.fr 12 One Frankfurter, please! Example : • Documenting the Wurst Machine
- 14. flacke@orange.fr 14 Twitter…? • Is the sausage machine twittable? Customer service on Twitter: • Does your software documentation pass the Twitter test? The key is to have many small help topics that focus on specific questions your customers have. http://tinyurl.com/9ryzwm8
- 15. flacke@orange.fr 15 Based on requirements • PreSales (Marketing) needs PreSales (Marketing) Product presentation Proposals (bid writing) Fact Sheets Leaflets PPT demos Videos Unsollicit ated Sollicitate d (RFPs) QR Codes Paper (pdf) Electr onic Paper (pdf) Electr onic Unsollici tated (PPT) Sollicitat ed (RFPs)
- 16. flacke@orange.fr 16 Based on requirements • Post Sales (Customer service) needs PostSales Installation Guide Operations Guide Maintenance Guide Paper (pdf) Web Twitter Mobile Electr onic UG QuickSta rt QuickSta rt OG MG Web Twitter Mobile Elect ronicVideo Video Paper (pdf) Paper (pdf) Electr onic Training HelpFil es
- 17. flacke@orange.fr 17 Sample • Fact sheet • Pre-Sales only? Volume: 5x 1,000 liter Connected load: 9,75 kW; 400 V; 50 Hz Max. Temperature: +3°C Inject-Star HS 3-5 tumbling line Equipment: - Computer control panel TC 20 - 20 different programms - modular system - machine in stainless steel - integrated vacuum pump DITA Reference Topic
- 18. flacke@orange.fr 18 Fact Sheet: multiple usage • Presales (1) • Paper or electronic Information needs Department P or E Usage One Page Fact sheet Pre Sales P, E Exhibition, Prospect visit Web Leaflets & catalogues Pre Sales P Exhibition, Prospect visit Proposals Marketing/ Engineering P RFP or unsolicitated Product presentation Marketing E Powerpoint, Videos, Twitter Single content, multiple usage 8!!!
- 19. flacke@orange.fr 19 Fact Sheet: multiple usage • Post sales (2) • Paper or electronic Information needs Depart.t P or E Format Installation Guide Post sales P, E Full Guide Operation Guide Customer Relation- ship P, E Full Guide, Quickstart Guide (pdf), Web (HTML) Online Help, Video Maintenance Guide Customer Support P,E Full Guide, Web, Mobile, Video, Online Help Course book Training P, E Powerpoint, Videos, Twitter, Web 15!!!!
- 20. flacke@orange.fr 20 Mobile- compatible? • Twitter compatible? Wurst Machine Frankfurter Star www.FrankfurterStar.com For Frankfurter, WeissWurst, Lyoner Wurst, Curry Wurst Reference: FW Inject 2012 Volume: 5 x 1,000 liter Vacuum pump: integrated Twitter compatible! Reference topics are designed for speed (*) (*) DITA Best practices, Michelle Carey
- 21. flacke@orange.fr21 Woongjin Coway Water purifier using a QR code management video QR code generated QR code attached to device QR code scanned with a smartphone / tablet computer QR code information sent to the server QR code analysis and instructional video Appropriate equipment related videos View Videos form Video sidebar Live-action movie
- 22. flacke@orange.fr 22 Re-Using ? • Internationally? • Re-Use in Pre-Sales 8 x •Re-Use in Post-Sales 15 x 22 x Re-using 22x „5x 1,000 liter“? Gallon vs Liter?
- 23. flacke@orange.fr 23 Based on Globalization requirements • 4 Regions Europe USA Asia North Africa
- 24. flacke@orange.fr 24 Based on Globalization requirements • Europe • USA Europe USA EU Machine Dir Legal Requ-EU CE Certification Languages: 8 EN – FR – DE – IT – SP – NL- SE - PT Legal Requ. US Languages: 2 EN - SP ANSI Illustrations Continental - UK Illustrations US
- 25. flacke@orange.fr 25 Based on Globalization requirements • North Africa • Asia Asia North Africa ISO Languages: 3 EN – CN - JP ISO Languages: 3 EN – FR – Arabic Illustrations ? Illustrations ?? Legal Requ. ? Legal Requ. Afr.
- 26. flacke@orange.fr 26 Globalization and Reuse ? • Languages: EN, FR, SP • Standards: ISO, EU • Units of measure: metric, imperial • Illustrations • Product names •Safety messages • 63% savings in translation [DITA Roi and translation, Mark Lewis /Quark Inc. See http://tinyurl.com/9jautrp]
- 27. flacke@orange.fr 27 Why Reuse ? • Standard compliancy • Minimizing risks Guide to EU Machine directive, page 286
- 28. flacke@orange.fr 28 Why Reuse ? • Which risks? • The description of different crosswind landing techniques (crab-angle, sideslip or a combination) contained in flight operations documentation FCOM, FCTM, FCOM Bulletins and FOBN were not uniform and in part contradictory. Investigation report
- 29. flacke@orange.fr 29 Why Reuse ? • Warning messages? "Warnings and cautions are a good example of reuse in aerospace documentation. They describe hazards that may cause injury or death or damage to the aircraft. For product liability reasons, these warnings and cautions are carefully reviewed and approved by qualified personnel. Technical authors may be required to reuse these warnings and cautions verbatim across all documents. " Applicable to Machine Industry! http://efasoft.blogspot.com/2008/05/s1000d- content-reuse.html
- 30. flacke@orange.fr 30 Updates ? • Automatic? • Accurate? •Temperature? 5° C instead of 3°C? • New filter? Forgot to update the Italian version for Tessin?
- 31. flacke@orange.fr 31 Evaluate Cost savings ? • Methodology? • Guesstimates? • Percent topic reuse • Fraction of topics reused somewhere • Average topic reuse • Average number of times a topic has been used
- 32. flacke@orange.fr 32 Evaluate Cost savings ? • Methodology? • Percent repository words reused! • Repository words reused in context • Ratio of the repository content to the produced content The ratio of the repository content to the produced content metric works at the content level rather than at the topic level. This metric is proportional to actual costs because translation is charged by the word, and maintenance costs are proportional to the volume of content rather than to the number of topics What is the Best Metric to Measure Success of Your Reuse of DITA Topics? Bill Hackos, CIDM Newsletter
- 33. flacke@orange.fr 33 Summary • Reuse through departments • Reuse in different formats • Reuse through countries and languages • Reuse for quality • Reuse for safety • Reuse for cost savings!
- 35. flacke@orange.fr 35 Questions ? … Hmm, I must meet Ms. DITA! Template: Kevin Lestang