SlideShare une entreprise Scribd logo
1  sur  32
Who’s afraid of the DITA Wolf? Suchi Govindarajan, MYOB Presented at AODC 2010 http://www.aodc.com.au/overview10.aspx
An origami exercise
Valley, mountain, and crease are the three types of folds from which all origami springs.  But even a valley fold is not necessarily the same as another valley fold if the layers of paper do not lie flat.  When models move into three dimensions, both valley and mountain folds can vary in another way: the fold angle, which can take on many values. [Origami Design Secrets, Robert Lang]  What if we’d started with this bit of theory instead?
There are four mathematical rules for producing flat-foldable origami crease patterns: crease patterns are two colorable at any vertex the number of valley and mountain folds always differ by two in either direction Kawasaki's theorem: at any vertex, the sum of all the odd angles adds up to 180 degrees, as do the even. a sheet can never penetrate a fold.    Or this? http://en.wikipedia.org/wiki/Mathematics_of_paper_folding
Theory versus practice
"I actually made something straight away“  		No more fear "I remember doing something like this before“ 		Builds on what you know  "I wonder how it works” 		Piques your curiosity "How did they come up with that? How would I make my own designs?” 		Path to more learning Practice is fun for beginners
Barriers to learning DITA You already know DITA The secret road Doubts? Go further And now to DITA
Barriers to Learning DITA(Theory & Jargon)
Let’s look at some DITA material “In this tutorial, you will learn the basic elements in a DITA topic and how they are specialized to become the three core DITA information types:  concept task reference" [http://www.ditausers.org/training/DITATopics/] 
DITA material (continued) “Darwin because its topics can be specialized to inherit properties of basic topics. Three basic Information Types are Concept, Task, and Reference topics. The Architecture is an XML standard, with Schemas and DTDs (document type definitions) maintained by OASIS. Topics can include other topics and sub-topics for flexible content reuse. ....” [http://www.ditausers.org/about_us/what_is_dita/]
DITA material (contd.) “Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering readable information as discrete, typed topics.”  [http://www.oasis-open.org/committees/dita/faq.php] “A method for organizing and publishing content based on reusable content components.”  [http://wiki.answers.com/Q/What_is_DITA_for_technical_documentation]
“The Darwin Information Typing Architecture (DITA) is an XML-based method for writing and delivering information in a variety of forms....” DITA is a standard for technical documents that’s designed to be used with XML. It comes with some free publishing tools.  A good, jargon-free definition for beginners http://www.informit.com/articles/article.aspx?p=663081
You already know DITA
DITA buzzword bingo DITA Buzzword Pre-DITA usage Content re-use Content model Single-sourcing Multi-channel publishing Topic-based authoring Maps Robohelp FrameMaker and friends Madcap Flare Tech writing principles
Separation of content and form
DITA versus Frame
The Secret Road Or “Just Do It"
DITA Users need not install anything1 or know XML to begin topic-based structured writing today.  The other way to DITA [http://www.ditausers.org/]
XML editor WYSIWOO view DITA-aware So DITA is just a matter of File> New So DITA rules are embedded So you can look up the DITA specifications in context Examples: XMLMind, XMetal The tool for this hike
Theory Elements Attributes The barest idea of Concept, Task, Reference Tips How to use the ID attribute Quirks of using the ENTER key Using the Insert options Things you need to know
Specialisation Customisation The DITA “topic" topic Inheritance Relationship tables DTDs XML rules, validation, well-formedness (really?) Things you don’t need to know
DITA OpenToolkit A closed mind Wolves on this road
Doubts?
In one hour, nine writers were able to: Write a concept and a task Create a map to pull them together They didn't know what elements were available They discovered them They guessed what they were for The XML Editor used was critical DITA-aware.  Used insert options to learn DITA rules DITA in a day workshop
Elements, attributes DITA being topic-based Authoring mechanics Basic structures No memory of previous DITA tutorials Minimalist introduction
Start with a great example Learn simple things first The task/concept/reference decision Notes Cross-references Hyperlinks Tables My rough guide
Download and analyse sample topics: http://dita‐ot.sourceforge.net/SourceForgeFiles/doc/user_guide.html Follow the tutorial in DITA for Solo Writers: http://www.ditausers.org/tutorials/lone‐dita/ditaguide.pdf Sample topics
http://docs.oasis-open.org/dita/v1.1/langspec/ditaref-type.html Description Example Contains Contained by Inheritance Attributes Refer to the DITA specification
Go further
WinANT It took 1 hour for the writers in my workshop to install DITA-OT, WinANT and publish to HTML, CHM and PDF XMLMind DITA Converter Publishing tools you may already own Publishing
Reinforce your learning Let your requirements guide you Let the possibilities guide you Don’t get taken in by the hype Don’t be cynical about the hype Iterations of theory and practice
Picture credits: Title credit: Ron Tierney www.flickr.com/photos/bookgrl/482232222/ www.flickr.com/photos/jon_tucker/4275210416/ www.flickr.com/photos/popupology/4105433338/ www.flickr.com/photos/shereen84/3187315381/ www.flickr.com/photos/origomi/17213276/ www.flickr.com/photos/vaguelyartistic/132177047/ www.flickr.com/photos/origomi/33173530/ www.flickr.com/photos/vaguelyartistic/132177047/ www.origami-fun.com/origami-pelican.html www.flickr.com/photos/vaguelyartistic/132177047/ http://tpettit.best.vwh.net /dolls/pd_scans/52valentine www.flickr.com/photos/ oschene/2497103604/

Contenu connexe

Similaire à Who's afraid of the DITA wolf?

Mathew DITA Deep Dive
Mathew DITA Deep DiveMathew DITA Deep Dive
Mathew DITA Deep Dive
akashjd
 
Topic-oriented writing at McAfee
Topic-oriented writing at McAfeeTopic-oriented writing at McAfee
Topic-oriented writing at McAfee
John Sarr
 
Introduction To Information Modeling With DITA
Introduction To Information Modeling With DITAIntroduction To Information Modeling With DITA
Introduction To Information Modeling With DITA
Scott Abel
 
Data Science Accelerator Program
Data Science Accelerator ProgramData Science Accelerator Program
Data Science Accelerator Program
GoDataDriven
 
Cloud Programming Models: eScience, Big Data, etc.
Cloud Programming Models: eScience, Big Data, etc.Cloud Programming Models: eScience, Big Data, etc.
Cloud Programming Models: eScience, Big Data, etc.
Alexandru Iosup
 

Similaire à Who's afraid of the DITA wolf? (20)

Developing dita maps
Developing dita mapsDeveloping dita maps
Developing dita maps
 
The Three Core Topic Types
The Three Core Topic TypesThe Three Core Topic Types
The Three Core Topic Types
 
Build your Chunks! Explain real life to Drupal in its own Words (at BADCamp 2...
Build your Chunks! Explain real life to Drupal in its own Words (at BADCamp 2...Build your Chunks! Explain real life to Drupal in its own Words (at BADCamp 2...
Build your Chunks! Explain real life to Drupal in its own Words (at BADCamp 2...
 
7-clean-code
7-clean-code7-clean-code
7-clean-code
 
Graph databases & data integration v2
Graph databases & data integration v2Graph databases & data integration v2
Graph databases & data integration v2
 
Mathew DITA Deep Dive
Mathew DITA Deep DiveMathew DITA Deep Dive
Mathew DITA Deep Dive
 
Topic-oriented writing at McAfee
Topic-oriented writing at McAfeeTopic-oriented writing at McAfee
Topic-oriented writing at McAfee
 
How DITA Got Her Groove Back: Going Mapless with Don Day
How DITA Got Her Groove Back: Going Mapless with Don DayHow DITA Got Her Groove Back: Going Mapless with Don Day
How DITA Got Her Groove Back: Going Mapless with Don Day
 
DITA's New Thang: Going Mapless!
DITA's New Thang: Going Mapless!DITA's New Thang: Going Mapless!
DITA's New Thang: Going Mapless!
 
TWC 545 Presentation-DITA
TWC 545 Presentation-DITATWC 545 Presentation-DITA
TWC 545 Presentation-DITA
 
Introduction To Information Modeling With DITA
Introduction To Information Modeling With DITAIntroduction To Information Modeling With DITA
Introduction To Information Modeling With DITA
 
Ad507
Ad507Ad507
Ad507
 
General Introduction for Semantic Web and Linked Open Data
General Introduction for Semantic Web and Linked Open DataGeneral Introduction for Semantic Web and Linked Open Data
General Introduction for Semantic Web and Linked Open Data
 
One-hour Drupal 8 Theming
One-hour Drupal 8 ThemingOne-hour Drupal 8 Theming
One-hour Drupal 8 Theming
 
Sweo talk
Sweo talkSweo talk
Sweo talk
 
James Coplien - Trygve - October 17, 2016
James Coplien - Trygve - October 17, 2016James Coplien - Trygve - October 17, 2016
James Coplien - Trygve - October 17, 2016
 
DITA 101 -- Why the Buzz
DITA 101 -- Why the BuzzDITA 101 -- Why the Buzz
DITA 101 -- Why the Buzz
 
Data Science Accelerator Program
Data Science Accelerator ProgramData Science Accelerator Program
Data Science Accelerator Program
 
Dita for the web: Make Adaptive Content Simple for Writers and Developer
Dita for the web: Make Adaptive Content Simple for Writers and DeveloperDita for the web: Make Adaptive Content Simple for Writers and Developer
Dita for the web: Make Adaptive Content Simple for Writers and Developer
 
Cloud Programming Models: eScience, Big Data, etc.
Cloud Programming Models: eScience, Big Data, etc.Cloud Programming Models: eScience, Big Data, etc.
Cloud Programming Models: eScience, Big Data, etc.
 

Dernier

Finding Java's Hidden Performance Traps @ DevoxxUK 2024
Finding Java's Hidden Performance Traps @ DevoxxUK 2024Finding Java's Hidden Performance Traps @ DevoxxUK 2024
Finding Java's Hidden Performance Traps @ DevoxxUK 2024
Victor Rentea
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Safe Software
 
Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
WSO2
 

Dernier (20)

Artificial Intelligence Chap.5 : Uncertainty
Artificial Intelligence Chap.5 : UncertaintyArtificial Intelligence Chap.5 : Uncertainty
Artificial Intelligence Chap.5 : Uncertainty
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024
 
Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...
Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...
Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...
 
Finding Java's Hidden Performance Traps @ DevoxxUK 2024
Finding Java's Hidden Performance Traps @ DevoxxUK 2024Finding Java's Hidden Performance Traps @ DevoxxUK 2024
Finding Java's Hidden Performance Traps @ DevoxxUK 2024
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processors
 
Ransomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdfRansomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdf
 
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot TakeoffStrategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
 
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ..."I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
Rising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdf
Rising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdfRising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdf
Rising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdf
 
Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
 
DBX First Quarter 2024 Investor Presentation
DBX First Quarter 2024 Investor PresentationDBX First Quarter 2024 Investor Presentation
DBX First Quarter 2024 Investor Presentation
 
Exploring Multimodal Embeddings with Milvus
Exploring Multimodal Embeddings with MilvusExploring Multimodal Embeddings with Milvus
Exploring Multimodal Embeddings with Milvus
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
 
presentation ICT roal in 21st century education
presentation ICT roal in 21st century educationpresentation ICT roal in 21st century education
presentation ICT roal in 21st century education
 
CNIC Information System with Pakdata Cf In Pakistan
CNIC Information System with Pakdata Cf In PakistanCNIC Information System with Pakdata Cf In Pakistan
CNIC Information System with Pakdata Cf In Pakistan
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, AdobeApidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
 
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
 

Who's afraid of the DITA wolf?

  • 1. Who’s afraid of the DITA Wolf? Suchi Govindarajan, MYOB Presented at AODC 2010 http://www.aodc.com.au/overview10.aspx
  • 3. Valley, mountain, and crease are the three types of folds from which all origami springs. But even a valley fold is not necessarily the same as another valley fold if the layers of paper do not lie flat. When models move into three dimensions, both valley and mountain folds can vary in another way: the fold angle, which can take on many values. [Origami Design Secrets, Robert Lang] What if we’d started with this bit of theory instead?
  • 4. There are four mathematical rules for producing flat-foldable origami crease patterns: crease patterns are two colorable at any vertex the number of valley and mountain folds always differ by two in either direction Kawasaki's theorem: at any vertex, the sum of all the odd angles adds up to 180 degrees, as do the even. a sheet can never penetrate a fold.   Or this? http://en.wikipedia.org/wiki/Mathematics_of_paper_folding
  • 6. "I actually made something straight away“ No more fear "I remember doing something like this before“ Builds on what you know "I wonder how it works” Piques your curiosity "How did they come up with that? How would I make my own designs?” Path to more learning Practice is fun for beginners
  • 7. Barriers to learning DITA You already know DITA The secret road Doubts? Go further And now to DITA
  • 8. Barriers to Learning DITA(Theory & Jargon)
  • 9. Let’s look at some DITA material “In this tutorial, you will learn the basic elements in a DITA topic and how they are specialized to become the three core DITA information types: concept task reference" [http://www.ditausers.org/training/DITATopics/] 
  • 10. DITA material (continued) “Darwin because its topics can be specialized to inherit properties of basic topics. Three basic Information Types are Concept, Task, and Reference topics. The Architecture is an XML standard, with Schemas and DTDs (document type definitions) maintained by OASIS. Topics can include other topics and sub-topics for flexible content reuse. ....” [http://www.ditausers.org/about_us/what_is_dita/]
  • 11. DITA material (contd.) “Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering readable information as discrete, typed topics.”  [http://www.oasis-open.org/committees/dita/faq.php] “A method for organizing and publishing content based on reusable content components.”  [http://wiki.answers.com/Q/What_is_DITA_for_technical_documentation]
  • 12. “The Darwin Information Typing Architecture (DITA) is an XML-based method for writing and delivering information in a variety of forms....” DITA is a standard for technical documents that’s designed to be used with XML. It comes with some free publishing tools.  A good, jargon-free definition for beginners http://www.informit.com/articles/article.aspx?p=663081
  • 14. DITA buzzword bingo DITA Buzzword Pre-DITA usage Content re-use Content model Single-sourcing Multi-channel publishing Topic-based authoring Maps Robohelp FrameMaker and friends Madcap Flare Tech writing principles
  • 17. The Secret Road Or “Just Do It"
  • 18. DITA Users need not install anything1 or know XML to begin topic-based structured writing today. The other way to DITA [http://www.ditausers.org/]
  • 19. XML editor WYSIWOO view DITA-aware So DITA is just a matter of File> New So DITA rules are embedded So you can look up the DITA specifications in context Examples: XMLMind, XMetal The tool for this hike
  • 20. Theory Elements Attributes The barest idea of Concept, Task, Reference Tips How to use the ID attribute Quirks of using the ENTER key Using the Insert options Things you need to know
  • 21. Specialisation Customisation The DITA “topic" topic Inheritance Relationship tables DTDs XML rules, validation, well-formedness (really?) Things you don’t need to know
  • 22. DITA OpenToolkit A closed mind Wolves on this road
  • 24. In one hour, nine writers were able to: Write a concept and a task Create a map to pull them together They didn't know what elements were available They discovered them They guessed what they were for The XML Editor used was critical DITA-aware. Used insert options to learn DITA rules DITA in a day workshop
  • 25. Elements, attributes DITA being topic-based Authoring mechanics Basic structures No memory of previous DITA tutorials Minimalist introduction
  • 26. Start with a great example Learn simple things first The task/concept/reference decision Notes Cross-references Hyperlinks Tables My rough guide
  • 27. Download and analyse sample topics: http://dita‐ot.sourceforge.net/SourceForgeFiles/doc/user_guide.html Follow the tutorial in DITA for Solo Writers: http://www.ditausers.org/tutorials/lone‐dita/ditaguide.pdf Sample topics
  • 28. http://docs.oasis-open.org/dita/v1.1/langspec/ditaref-type.html Description Example Contains Contained by Inheritance Attributes Refer to the DITA specification
  • 30. WinANT It took 1 hour for the writers in my workshop to install DITA-OT, WinANT and publish to HTML, CHM and PDF XMLMind DITA Converter Publishing tools you may already own Publishing
  • 31. Reinforce your learning Let your requirements guide you Let the possibilities guide you Don’t get taken in by the hype Don’t be cynical about the hype Iterations of theory and practice
  • 32. Picture credits: Title credit: Ron Tierney www.flickr.com/photos/bookgrl/482232222/ www.flickr.com/photos/jon_tucker/4275210416/ www.flickr.com/photos/popupology/4105433338/ www.flickr.com/photos/shereen84/3187315381/ www.flickr.com/photos/origomi/17213276/ www.flickr.com/photos/vaguelyartistic/132177047/ www.flickr.com/photos/origomi/33173530/ www.flickr.com/photos/vaguelyartistic/132177047/ www.origami-fun.com/origami-pelican.html www.flickr.com/photos/vaguelyartistic/132177047/ http://tpettit.best.vwh.net /dolls/pd_scans/52valentine www.flickr.com/photos/ oschene/2497103604/