technical documentation from failure to successdownloadcentre.sdl.com/tridion/sc-summit-2012/... ·...
TRANSCRIPT
![Page 1: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/1.jpg)
Technical documentation from failure to success
Pascal Kesselmark
Manager Technical DocumentationKlingelnberg AG
![Page 2: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/2.jpg)
About me• Journalist/Author
• Technical Communicator with Swiss Federal Diploma of Professional Education and Training
• Ing. EurEta Computer Science
• Manager Technical Dokumentation since 2002
• Manager TechDoc
• Since 2008
• President
• www.tecom.ch
![Page 3: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/3.jpg)
About Klingelnberg
• Founded in 1863
• Family business
• In the 7th generation, owner-management
• Leading international company in gear technology
• More than 1000 staff in the Klingelnberg Group
• Turnover of Klingelnberg Group: approx. 175 m€
![Page 4: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/4.jpg)
Klingelnberg AG in Zürich, Switzerland – formerly known as Oerlikon Geartec is the headquarter. Production plants are located in Hückeswagen, Germany. The TechCenter is based in Ettlingen.
Klingelnberg GmbH, HückeswagenKlingelnberg AG, Zürich Ettlingen branch
Locations
![Page 5: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/5.jpg)
TechDoc @ Klingelnberg
• Team working from 4 locations (Europe & Asia)
• Technical Editors, Terminologist and Translation Management
• Source language is german
• Approx. 600 documents per year (TechDoc)
• Size of documents 200 – 600 pages
• Translation in 12 languages
![Page 6: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/6.jpg)
Publication system
Publication System
![Page 7: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/7.jpg)
Technical Documentation
![Page 8: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/8.jpg)
acceptance approval budget costumer_requests creativity delay
editorial_deadline editorial_guideline graphics
importance interfaces lack_of_information language_variants
legally_compliant options overload priority processes
production_time publication_system responsibilities rules
service_provider software_development standard internal_status structure
supervisor supplier_documentation
terminology text time_schedule tools
translation_oriented translation_time work_environment work_equipment_regulation writing_rules
![Page 9: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/9.jpg)
2008
![Page 10: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/10.jpg)
From 2008 until now
![Page 11: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/11.jpg)
![Page 12: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/12.jpg)
![Page 13: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/13.jpg)
![Page 14: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/14.jpg)
![Page 15: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/15.jpg)
![Page 16: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/16.jpg)
![Page 17: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/17.jpg)
![Page 18: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/18.jpg)
![Page 19: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/19.jpg)
![Page 20: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/20.jpg)
![Page 21: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/21.jpg)
![Page 22: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/22.jpg)
![Page 23: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/23.jpg)
![Page 24: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/24.jpg)
How did we do it?
![Page 25: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/25.jpg)
By just improving everything!
1. Restructuring and rewriting all Content and more
2. Using the right Translation and Terminology Software
3. Implementing Author Assisting tool
4. Developing Functions by ourself which were not available on the market
![Page 26: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/26.jpg)
Restructuring and rewriting all content and
more
Restructuring and rewriting all content and
more
![Page 27: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/27.jpg)
What we did:1. Analyse Target Group and Information Demand
2. Problem Analysis on existing documents
3. Defining and Structuring new documents
4. Create Sample Documents
5. Identify reusable semantic structures
6. Define editorial Standard for text and pictures
7. Analyse and redefine Processes
8. (Implement Publication System,) Qualify editors
9. Regularly audit and improve documents and processes
![Page 28: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/28.jpg)
Using the right translation and terminology softwareUsing the right translation and terminology software
![Page 29: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/29.jpg)
Experience with prior tool provider• Actual costs came after buying the software• Additional «forgotten» modules were very expensive• "Bottomless pit" because no advice on implementation
All inclusive or not?
Experience with SDL Trados• After 2 days the system was
running on our own servers• Complete package
(no extra cost)• Professional technical advice
before the purchase
![Page 30: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/30.jpg)
Optimal localisation, worldwide
We need to be have translations on time and for the best price
• Localisation/proof reading in market
• Speed is critical (penalty)• Accuracy of the calculated
translation cost
![Page 31: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/31.jpg)
Implementing Author Assisting Tool
Implementing Author Assisting Tool
![Page 32: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/32.jpg)
Author Support
• Showing existing content while writing
• Checking against translation memory
• Checking terminology
• Checking own rules
• Grammar checking
![Page 33: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/33.jpg)
![Page 34: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/34.jpg)
![Page 35: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/35.jpg)
![Page 36: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/36.jpg)
![Page 37: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/37.jpg)
![Page 38: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/38.jpg)
Analysis report
![Page 39: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/39.jpg)
Additional functions developed by ourselfAdditional functions developed by ourself
![Page 40: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/40.jpg)
Quality Checks and Improvements with VBA
• Check modules and documents
• Configurated symbol bar
• Template for structured content
• Optimised indexes for pictures and tables
![Page 41: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/41.jpg)
Correct sequencing
through Autotexts
![Page 42: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/42.jpg)
Semantic Structure for Instructions
Derived rules:• A-er «L0:Handlung» can ... come
• Before «Marginale» must be «L1: Handlung_Ende»
• Other formats are not allowed
![Page 43: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/43.jpg)
Summary
• Build a good base or get capable help
• Then get the right tools
• Improve constantly content & processes
• Be creative with your solutions and have fun improving them
![Page 44: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/44.jpg)
Results
• Consistent documents
• Higher reuse of content
• Less problems with translations, it‘s faster and cheaper
• Better customer experience
…and this thanks to a combined approach of rules, author support and quality checks
![Page 45: Technical documentation from failure to successdownloadcentre.sdl.com/tridion/SC-Summit-2012/... · Pascal Kesselmark Manager Technical Documentation ... production_time publication_system](https://reader033.vdocuments.site/reader033/viewer/2022050608/5faf14ca88009c799b3ba9ba/html5/thumbnails/45.jpg)
Questions?Now, during the day or contact me later:[email protected]