SlideShare a Scribd company logo
Painless XML Authoring? How DITA Simplifies XML Bob Doyle [email_address] [email_address] 617-876-5676 Skype: bobdoyle
A brief poll.  Who’s heard of… Structured writing? Information Mapping? Task-oriented Documentation? vs. ?  Minimalism? John Carroll? Single-source publishing? vs. Reuse? Component Content Management? Topic-based authoring?  Bob Horn, John Brockmann, JoAnn Hackos, Ginny Redish, Ruth Clark?
All heard of DITA? Information Typing Topics: Concept, Task, and Reference DITA Maps DITA Open Toolkit DITA is Simplified XML Specialization
Heard of me? Ph.D. Astrophysics, Harvard, 1968 Collaborative Observing Program,  NASA Skylab 1970-72 Super8 Sound, 1973-78 Merlin and 5 other computer games– 1977-81 iXO Telecomputer – 1980-87 MacPublisher – 1984-1987 Digital Video Editor, New Media Magazine -1993-1999
Parker Brothers Games
iXO Telecomputer Computer-initiated dialogues (AI) Yes, No, Help, Repeat keys “ Operators are standing by” Stock trades, airline reservations, bill paying. Hearing-impaired Powered from phone line Venture capital $13 million Never developed the backend database services Huge NOL carry-forward
MacPublisher First Desktop Publishing Program 11 th  Certified Mac Developer Shipped in 1984 Laserwriter in 1985 First “spot color” text on Apple Imagewriter First rotated text/gaphics Sold 20,000 copies MacIndexer Mac-Hyphen Sold to Letraset in 1987
Doing What Recently CEO, skyBuilders.com Editor, CMS Review   related websites – CMS Wiki, CMS Forum, CMS News, CMS Calendar, CMS Glossary, CMSML, CMS Boston, Open Internet Lexicon, TaxoTips Founder, CM Professionals Contributing Editor, EContent Magazine Founder, DITA Users related websites – DITA Infocenter, DITA News, DITA Newsletter, DITA Blog, DITA Wiki, and DITA Tutor
The First Podcast - 2003 Christopher Lydon (NPR’s “The Connection”) Dave Winer Adam Curry Bloggercon BlogAudio.org Lydon’s “Open Source” Show
EContent Magazine Contributing Editor 6 columns per year XML Authoring Tools Review 12 online columns per year EC100 selection
Joined OASIS - 2006 Organization for the Advancement of Structured Information Standards Member – DITA Technical Committee Member – Learning and Content SC Member – Help SC Observer – Translation SC Member – Editorial Board Organizer – Boston DITA User Group
DITA Users – Launched in March DITA Users is an international membership organization  ~400 members from 21 countries. Members learn topic-based structured writing.  Author DITA with DITA Storm browser-based editor  Deliverables for web (XHTML), print (PDF), Help (Eclipse) from single-source documents.  Members have a personal workspace folder. Finished work on web to show colleagues and clients.  Member directory has contact information.  Discounts on major DITA conferences, on tools (?), on DITA tutorials and workshops, and on the DITA Report.
DITA Infocenter – Launched April DITA Infocenter is Eclipse-based Online Help DITA Architectural Specification (1.0 and 1.1) DITA Language Specification (1.0 and 1.1) Open Toolkit User Guide (1.3.1) Full-text search Index of keywords  Table of contents Generated from DITA files with Open Toolkit
DITA News – Launched June Aggregates blog posts from DITA bloggers. Extensive listings of DITA tools from A to Z. Events calendar with conference listings,  Websites, Publications, Webinars. Glossary of DITA terms.  Content syndicated to other websites  Single-source publishing tools.
DITA Blog – Launched July Group blog Anyone may join RSS feeds syndicate to DITA News
DITA Wiki – Launched July Resources with comments and discussions.  Mediawiki software (Wikipedia) Architectural and Language specifications  Vendors and Products Professional Services Edited directly by the vendors User comments People section -  major DITA players Glossary of terms
DITA Newsletter – Launched September Monthly summary of DITA news Industry mailing list for press releases. DITA Mentor Awards Next month’s events listings Member discount offers
DITA Tutor – Launched September Learning management system (Moodle LMS)  Self-paced online tutorials Instructor-led online workshops  Powerpoint presentations  Some with audio recording Recorded webinars  Courses in DITA techniques  Certificates of completion.
DITA User Groups [email_address] http://dita.xml.org/user-groups Encouraging remote attendance Recording meeting presentations Archiving to DITA Tutor Possibly repurpose as eLearning What collaboration tools should we use?
Structured Writing – 1960’s and 70’s Structured writing requires an analysis of content and a reorganization into the smallest possible coherent topics. Decades of research on such analysis and organization have been done by  Information Mapping™ , who identified common document types, information types, and information blocks (chunks or topics) in use in education and commerce.  The reduction in structured authoring time may be offset by the increased time needed to analyze the content and break it into reusable chunks. There is no doubt that granular content, with well-defined purposes for each paragraph and sentence, is easier to author than linear content. But you may need skilled (i.e., more expensive) information developers to chunk your material.
Task-oriented Documentation – 1980’s Task-oriented docs have replaced system-oriented or product-oriented docs - the old comprehensive user manual. ROI - The number of calls per month to the help desk on a product will almost certainly change when product documentation is task oriented and minimalist. And task-oriented content can feed directly into help-desk scripts.
Minimalism – 1990’s Minimalism aims to provide just what the impatient user is looking for. Remember, the web surfer is always just one click away from going to your competition's website. Your job is to strip away unnecessary content and get to the point. You can measure the return by pre-testing and post-testing content that has been re-architected along minimalist principles. Minimalism appears to promise reduced costs for the simple reason that there is so much less content in well-prepared minimalist material. But it takes talented people to write succinct, action-oriented procedures that get users to understand quickly what they need to know and successfully do it. And minimalist material is best when it is tested for effectiveness, adding to costs.
Single-source Publishing – 1990’s The original definition of single-source publishing was providing multiple output formats like Web, Print, and Online Help from the original documents.  When you have one source for each piece of content, you get the astonishing ability to change it in one place and have the change propagate everywhere. A product name change becomes much more manageable. Your business-critical marketing messages are standardized everywhere. Some call single source a "single source of truth" because you are assured that your customers are not getting mixed messages that can confuse them, reduce sales, and increase the need for tech support.
Single-source plus Reuse Reusable content has a single source, of course, but reuse generally refers to content originally developed for one context that can be reused in another. This requires content that is topic-based and written for reuse by avoiding explicit references to context.  The cost savings associated with reuse of content increase greatly when your content goes through a workflow with distinct review and approval stages, for example legal approval. Content that is reused generally can avoid all or most of the extra steps in the workflow that involve accuracy of content. You will still need design approval of the in-context appearance of the reused content.
Component Content Management The latest buzzword in CMS is "component." Most web content management (WCMS) segment content at the web page. While this may be adequate for simple websites written by one or a few content contributors, it is not acceptable for websites whose pages act as portals to diverse kinds of interactive content.  Modern corporate pages pull content in from multiple sources. Each content block is filled with a content component managed independently of all the other blocks on the page. A component has its own versioning and scheduling, its own writers, reviewers, and approval process.
Topic-based authoring A topic is a unit of information with a title and some form of content, short enough to be specific to a single subject or answer a single question, but long enough to make sense on its own and be authored as a unit.  A topic aims to be context-free, so it contains no links to other topics. In DITA, the topic is the basic unit of authoring and of reuse. A topic is a content component
Why Concept, Task, and Reference? Remember Macintosh doc guidelines? Learning MacPaint, Using MacPaint, the MacPaint Reference. Today’s O’Reilly Books – Learning PHP, Programming PHP, PHP – the Definitive Reference Concept = What is it? Task = How do I do…? Reference = All the details.
What’s a DITA Map? The DITA Map provides  context  for your context-free topics – the  content . You can have many maps, each one arranging the topics for different requirements – a reference manual, a tutorial, a help desk. The map is like a table of contents that rebuilds the book dynamically.
What’s the DITA Open Toolkit? The Open Toolkit is an open-source end-to-end single-source publishing system. It takes your topics and your maps and generates multiple output format deliverables, like print (PDF), web (HTML), and Help. It is free and has been integrated into leading DITA editing and CMS tools.
Why Simplified XML? DITA is XML. XML is way harder than HTML and most writers want no part of HTML. So how can DITA be easier than XML? Because XML separates  content  from  presentation And it also separates  content  from  structure
What Is Content Anyway? It’s not the Presentation or the Structure! Separate Presentation Layer from Content Structure the Content Tag Content with Meaning (semantics) by Metadata
Three Kinds of Markup The three layers use  different “markup” Style - <font>, <b>, <i> Structure - <p>, <ol> Semantics <name>, <price>, <product>
Three Kinds of XML The three layers use  different technologies XSLT Stylesheets (CSS) XML Schemas (DTDs) XML/DITA Documents
Three Different Professions  The three layers are the work of different professionals Designers for Style Architects for Structure Authors for Content and metadata
Simplified XML again The DITA Open toolkit is XML with a starter set of stylesheets (XSLTs) and schemas (DTDs) so your organization does not have to invest in months or years of development But simplified can be too simple…
DITA is not for writers alone.. Without style designers… (XSLTs) Without structural architects… (DTDs) DITA sucks! It’s like publishing your annual report in Notepad text! Although topics are components, they don’t have the metadata needed to  assemble  them intelligently.
So what’s the benefit for writers? Your work can feed into the dynamic assembly of complex information products Websites, Help systems, Custom Print Documentation, Mobile snippets You are an assembly line writer in the age of information automation! Love it or hate it?
Topics are Content Components Even subtopic elements can be reusable components Elements just need unique IDs Then they can be  conref ’d (content referenced) which means you can include  them by reference in other topics. Specialized  topics have metadata created by the structure architects.
So what is specialization? You can specialize structures You can specialize element names Then valid topics can be written in DITA-compliant authoring tools without knowing anything about the underlying XML And they can be assembled automatically using the metadata implicit in the specialization.
Three examples of specialization Concepts are specialized topics Tasks are specialized topics References are specialized topics By understanding those specializations, you will know how specialization works But remember that specialization is the work of document architects and information designers
A close look at a topic A  topic  has only three  required  elements. an  id  attribute in the main topic tag (for reuse) a  title a  body
A close look at a topic… It can have dozens of optional elements, many of which are very familiar HTML elements, like paragraphs <p>, lists <ul>, and tables <table>
A close look at a topic… Elements are shown schematically as colored boxes in a hierarchy. They are actually XML tag structures, properly nested and well formed.  <topic id=&quot;1&quot;> <title>My Topic</title> <shortdesc>About my topic...</shortdesc> <body> <p>Some content</p> <p>Some more content</p> </body> </topic>
The Concept Type The  concept  type specializes topic element names and topic structure. The root element is renamed  concept  and the body element is renamed  conbody . Any number of  paragraphs ,  lists ,  tables , etc. may appear, but none of these are allowed after the first  section  or  example . Sections and examples can then appear in any order.
The Task Type The  task  type specializes topic element names and topic structure. The root element is renamed  task  and the body element is renamed  taskbody . One task  prerequisite  and one  context  (both specializations of  section ) are followed by  steps  (a specialization of  ordered list ). Each step must have a  command , then optional  info , a  step example ,  choices , and a  step result .  The set of steps is followed by the task  result ,  examples , and any task  postrequisite .
The Reference Type The  task  type specializes topic element names and topic structure. The root element is renamed  reference  and the body element is renamed  refbody . The  refbody  includes a  properties  element (a specialization of  simpletable ) a three-column table of property types, values, and descriptions. The element refsyn (reference syntax) is a specialization of the  section  element.
Thank you.  Contact Bob Doyle [email_address] [email_address] Read my EContent articles www.econtentmag.com/About/AboutAuthor.aspx?AuthorID=155 Please join DITA Users www.ditausers.org/membership/how_to_join Merlin lives! www.theelectronicwizard.com This presentation is online at: www.ditausers.org/users/bobdoyle/DocTrainEast2007.ppt
DITA Users Network – 2007 DITA Blog DITA Infocenter DITA News DITA Newsletter DITA Tutor DITA Users DITA Wiki
DITA Report - November Coming November 2007 Based on my XML Editors Review Marketplace analysis Vendors and Products Evaluated Strategies from 1 to 100s of writers Online tour of authoring tools
XML Editors Altova XML Spy Cladonia Exchanger Stylus Studio SyncRO Soft <oXygen/> Adobe FrameMaker Arbortext Editor XMetal Author Syntext Serna Eight top XML Editors were studied Chosen from  6 5  i n CMS Review Editor Listings P ublished in the June issue of EContent Magazine Extended version - XML Editors Report
Which Editors Do You Use? A quick poll of your experience
The XML Editors Report Personal use license Corporate license One year of release versions Online consulting included Screen share to look at interfaces
CM Pros Best Practices
CMS Trends Open Source (and Open Documents) Online (ASPs and Web Services) Offshore? (Globalization) Enabling technologies (XML, Javascript) AJAX, Web 2.0
Information Architecture and Content Management. Two Kinds  of Information Architecture IA of document sets, books in a library, a website, the World Wide Web – organization, cataloging, metadata tagging, accessibility, findability.  IA of a single document - page structure, allowed navigation elements and reusable content components.
Defining Content Management What is a CM System? What Is Content Management?  What Is Content?
What is a CM System? It is humans using computers and  software to assist in managing content. It has two main parts: The user interface. The database (content repository). Everything else is  magic  middleware. It helps manage the  content lifecycle.
What Is Content Management? Content management is the whole process from creation and capture of original content to the delivery of different versions to many publishing channels: Print Web Cellphone Etc.
The Content Lifecycle 7 stages Organize Rules Create Storage Assembly Publish Archive Context Users Content
Brown Television (BTV) Doug Liman
Hi-8 Users Group Funded Videomaker Magazine, Hi-8 Group became Desktop Video Group in 1992
HRTV and Quad Sound Harvard-Radcliffe Film Workshop was in the basement of Holmes Hall (North/Pforzheimer House) where the old Radcliffe Radio Station and Morse Music Library were located. In the mid-80’s it became HRTV and the radio broadcast booth and adjoining sound rooms became Quad Sound Studios.
CMS Review
Other CMS Review Sites CMS Forum CMS Wiki CMSML CMS News CMS Calendar CMS Glossary CMS Boston Memography Open Internet Lexicon TaxoTips List-2-Web
CMS Review Glossary
Finding a CMS The CMSML project at CMS Review and CM Pros Select two CMS or enter search terms to find CMS that match your criteria. The directory is a  faceted  classification scheme. Click compare to get the results below...
CM Professionals Nearly 1000 members in 2006 Website (7/10 Google PageRank) Benefits - Mail, Member Directory Glossary, Resource Library, Calendar Communi ties - CMSML, DITA, Global News, Blog aggregation Globalization, Personalization
CM Professionals
CM Pros Member Directory
CM Pros Calendar
CM Pros Videos Eighty hours of video from Gilbane Conferences,  IA Summit, OSCOM, Bloggercons at Harvard. Bob Boiko interviews Shino
CM Pros Communities CMS Markup Language  (and Faceted CMS Directory) Globalization – website in 10 languages (translations by volunteers) DITA  (JoAnn Hackos, Scott Abel, others)
DITA Island Second Life meetings on DITA

More Related Content

PDF
DITA Quick Start
PPTX
DITA Quick Start: System Architecture of a Basic DITA Toolset
PPTX
Introduction to DITA
PPTX
What They Won't Tell You About DITA
PPTX
DITA Quick Start for Authors - Part I
PPTX
DITA Quick Start Webinar: Defining Your Style Sheet Requirements
PPTX
Introduction to DITA
PDF
Using DITA without becoming a Geek
DITA Quick Start
DITA Quick Start: System Architecture of a Basic DITA Toolset
Introduction to DITA
What They Won't Tell You About DITA
DITA Quick Start for Authors - Part I
DITA Quick Start Webinar: Defining Your Style Sheet Requirements
Introduction to DITA
Using DITA without becoming a Geek

What's hot (20)

PDF
What is DITA? And Is It Right for Your Team or Project?
PPTX
The DITA Iceberg, DITA Europe 2016
PPTX
DITA and Agile Are Made For Each Other
PPTX
Localization and DITA: What you Need to Know - LocWorld32
PDF
Keeping the Content Train on the Tracks (And on Topic)
PPTX
Optimizing DITA Content for Search Engine Optimization tekom tcworld 2016
PDF
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
PPTX
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
PPTX
TC Dojo Open Session: Are You Getting the Most Out of DITA Content Reuse?
PDF
Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
PPTX
DITA Quick Start Webinar Series: Building a Project Plan
PPTX
Optimizing Content Reuse with DITA
PPTX
10 Million Dita Topics Can't Be Wrong
PDF
DITA For Publishers: How Publishers Can Really Do XML
PPT
Collaborative authoring in DITA
PPT
Using DITA for Online Help
PPTX
Introduction to structured authoring
PPTX
Pat Farrell, Migrating Legacy Documentation to XML and DITA
PPTX
BUILDING YOUR ADAPTIVE MODEL: Setting Goals Using the Adaptive Content Maturi...
What is DITA? And Is It Right for Your Team or Project?
The DITA Iceberg, DITA Europe 2016
DITA and Agile Are Made For Each Other
Localization and DITA: What you Need to Know - LocWorld32
Keeping the Content Train on the Tracks (And on Topic)
Optimizing DITA Content for Search Engine Optimization tekom tcworld 2016
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
TC Dojo Open Session: Are You Getting the Most Out of DITA Content Reuse?
Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
DITA Quick Start Webinar Series: Building a Project Plan
Optimizing Content Reuse with DITA
10 Million Dita Topics Can't Be Wrong
DITA For Publishers: How Publishers Can Really Do XML
Collaborative authoring in DITA
Using DITA for Online Help
Introduction to structured authoring
Pat Farrell, Migrating Legacy Documentation to XML and DITA
BUILDING YOUR ADAPTIVE MODEL: Setting Goals Using the Adaptive Content Maturi...
Ad

Viewers also liked (20)

PPT
Building An XML Publishing System With DITA
PPTX
Conference Room Prototype – a low cost, high value approach to selecting the ...
PDF
Maximize Your oXygen Usage - oXygen XML, Syncro Soft
PDF
Using DRM at Infor - IXIASOFT User Conference 2016
PDF
Move Our DITA Content to Another CCMS? Seriously? - IXIASOFT User Conference ...
PPTX
Best practices when migrating to DITA
PPTX
STC Austin: Best practices when migrating to DITA
PPTX
Minimalism for MSU Tech Comm
PPTX
XML for Humans: Non-geek Discussion of a Geek-chic Topic
PPT
Agile Enterprise Publishing
PDF
DITA PUBLISHING: The True Cost of Taking your DITA Content Online
PPTX
Content creation, reuse, and publishing to everyone on every device (WritersUA)
PDF
Improving the mobile learning experience using DITA
PPTX
Topic based writing from idea to output
PPTX
XML authoring simplified for one and all: Writers UA
PPTX
Adobe DITA World: Templates, DITA, and FrameMaker 2015
PDF
Reports and DITA Metrics IXIASOFT User Conference 2016
PPTX
Introduction to Structured Authoring
PDF
Lte kpi accessability
PPT
Initial LTE call Setup Flow
Building An XML Publishing System With DITA
Conference Room Prototype – a low cost, high value approach to selecting the ...
Maximize Your oXygen Usage - oXygen XML, Syncro Soft
Using DRM at Infor - IXIASOFT User Conference 2016
Move Our DITA Content to Another CCMS? Seriously? - IXIASOFT User Conference ...
Best practices when migrating to DITA
STC Austin: Best practices when migrating to DITA
Minimalism for MSU Tech Comm
XML for Humans: Non-geek Discussion of a Geek-chic Topic
Agile Enterprise Publishing
DITA PUBLISHING: The True Cost of Taking your DITA Content Online
Content creation, reuse, and publishing to everyone on every device (WritersUA)
Improving the mobile learning experience using DITA
Topic based writing from idea to output
XML authoring simplified for one and all: Writers UA
Adobe DITA World: Templates, DITA, and FrameMaker 2015
Reports and DITA Metrics IXIASOFT User Conference 2016
Introduction to Structured Authoring
Lte kpi accessability
Initial LTE call Setup Flow
Ad

Similar to Painless XML Authoring?: How DITA Simplifies XML (20)

PPT
Doctraineast2008
PPT
DITA, Semantics, Content Management, Dynamic Documents, and Linked Data – A M...
PPS
Modular Documentation Joe Gelb Techshoret 2009
PPT
Feedable, Portable, Mashable, DITAble
PPT
Mapping the content ecosystem
PDF
Introduction to ePublishing
PPT
Planning and Managing Digital Library & Archive Projects
PPTX
What “Model” DITA Specializations Can Teach About Information Modelinc
ODP
DITA in the Open Source CMS Drupal - Baltimore 2011
PPT
Topic based and structured authoring - slides
PPT
Topic based and structured authoring - slides
PPT
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
PPTX
Share Point User Group Content Is King
PDF
White paper dita for everyone
PDF
White paper dita for everyone
PPT
Understanding and Communicating the Financial Impact of XML & DITA
PDF
Information Architecture
PPTX
DITA Collaboration for Content
PPT
Kbee Spaces Financial Services
PPT
Content Management, Metadata and Semantic Web
Doctraineast2008
DITA, Semantics, Content Management, Dynamic Documents, and Linked Data – A M...
Modular Documentation Joe Gelb Techshoret 2009
Feedable, Portable, Mashable, DITAble
Mapping the content ecosystem
Introduction to ePublishing
Planning and Managing Digital Library & Archive Projects
What “Model” DITA Specializations Can Teach About Information Modelinc
DITA in the Open Source CMS Drupal - Baltimore 2011
Topic based and structured authoring - slides
Topic based and structured authoring - slides
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
Share Point User Group Content Is King
White paper dita for everyone
White paper dita for everyone
Understanding and Communicating the Financial Impact of XML & DITA
Information Architecture
DITA Collaboration for Content
Kbee Spaces Financial Services
Content Management, Metadata and Semantic Web

More from Scott Abel (20)

PPTX
2023 Challenges and Opportunities Impacting Technical Documentation Team Capa...
PDF
The Cognitive Era and the Future of Content
PDF
The cognitive era and the future of content
PDF
Establishing thought leadership with content manufacturing and influencer mar...
PDF
Creating A Digital Content Factory: Getting Started with Intelligent Content
PDF
Intelligent Content in the Experience Age by Scott Abel, The Content Wrangler
PDF
Emerging Trends in Visual Content Marketing with Adam Helweh
PDF
Scalable Content Strategy: Nice Thought or Viable Vision? with Colleen Jones
PDF
Content Strategy Across Geographies and Platforms with Melinda Flores
PDF
The ROI of Intelligent Content with Mark Lewis, DITA Educator, Quark
PDF
Content Strategy for Technical Communication and Beyond with Gretyl Kinsey, S...
PDF
The Future of Technical Communication is Marketing with Scott Abel, The Conte...
PDF
Clear and Simple: Lower Your Content Costs with Global English with Matthew K...
PDF
Fandom Isn't Random with Andrew Thomas, SDL
PDF
Deep Dive: Structured XML Authoring with George Bina, oXygen XML Editor
PDF
The Future of Technical Communication is Marketing
PDF
The Making of 'The Language of Content Strategy' - by Scott Abel, The Content...
PDF
5 Revolutionary Technologies Technical Communicators Can’t Afford To Ignore
PDF
Content Marketing Futurist: Revolutionary Technologies Content Marketers Can’...
PDF
Thinking Strategically About Content - Localization World Singapore
2023 Challenges and Opportunities Impacting Technical Documentation Team Capa...
The Cognitive Era and the Future of Content
The cognitive era and the future of content
Establishing thought leadership with content manufacturing and influencer mar...
Creating A Digital Content Factory: Getting Started with Intelligent Content
Intelligent Content in the Experience Age by Scott Abel, The Content Wrangler
Emerging Trends in Visual Content Marketing with Adam Helweh
Scalable Content Strategy: Nice Thought or Viable Vision? with Colleen Jones
Content Strategy Across Geographies and Platforms with Melinda Flores
The ROI of Intelligent Content with Mark Lewis, DITA Educator, Quark
Content Strategy for Technical Communication and Beyond with Gretyl Kinsey, S...
The Future of Technical Communication is Marketing with Scott Abel, The Conte...
Clear and Simple: Lower Your Content Costs with Global English with Matthew K...
Fandom Isn't Random with Andrew Thomas, SDL
Deep Dive: Structured XML Authoring with George Bina, oXygen XML Editor
The Future of Technical Communication is Marketing
The Making of 'The Language of Content Strategy' - by Scott Abel, The Content...
5 Revolutionary Technologies Technical Communicators Can’t Afford To Ignore
Content Marketing Futurist: Revolutionary Technologies Content Marketers Can’...
Thinking Strategically About Content - Localization World Singapore

Recently uploaded (20)

PDF
Unit 1 Cost Accounting - Cost sheet
PDF
Elevate Cleaning Efficiency Using Tallfly Hair Remover Roller Factory Expertise
PDF
kom-180-proposal-for-a-directive-amending-directive-2014-45-eu-and-directive-...
PPTX
5 Stages of group development guide.pptx
PPTX
AI-assistance in Knowledge Collection and Curation supporting Safe and Sustai...
DOCX
Business Management - unit 1 and 2
PDF
Traveri Digital Marketing Seminar 2025 by Corey and Jessica Perlman
PPTX
The Marketing Journey - Tracey Phillips - Marketing Matters 7-2025.pptx
PPTX
Probability Distribution, binomial distribution, poisson distribution
PDF
Reconciliation AND MEMORANDUM RECONCILATION
PDF
DOC-20250806-WA0002._20250806_112011_0000.pdf
PDF
BsN 7th Sem Course GridNNNNNNNN CCN.pdf
PDF
Roadmap Map-digital Banking feature MB,IB,AB
PPT
Data mining for business intelligence ch04 sharda
PPTX
CkgxkgxydkydyldylydlydyldlyddolydyoyyU2.pptx
PDF
Types of control:Qualitative vs Quantitative
PPTX
HR Introduction Slide (1).pptx on hr intro
PPT
340036916-American-Literature-Literary-Period-Overview.ppt
PDF
Ôn tập tiếng anh trong kinh doanh nâng cao
PDF
Laughter Yoga Basic Learning Workshop Manual
Unit 1 Cost Accounting - Cost sheet
Elevate Cleaning Efficiency Using Tallfly Hair Remover Roller Factory Expertise
kom-180-proposal-for-a-directive-amending-directive-2014-45-eu-and-directive-...
5 Stages of group development guide.pptx
AI-assistance in Knowledge Collection and Curation supporting Safe and Sustai...
Business Management - unit 1 and 2
Traveri Digital Marketing Seminar 2025 by Corey and Jessica Perlman
The Marketing Journey - Tracey Phillips - Marketing Matters 7-2025.pptx
Probability Distribution, binomial distribution, poisson distribution
Reconciliation AND MEMORANDUM RECONCILATION
DOC-20250806-WA0002._20250806_112011_0000.pdf
BsN 7th Sem Course GridNNNNNNNN CCN.pdf
Roadmap Map-digital Banking feature MB,IB,AB
Data mining for business intelligence ch04 sharda
CkgxkgxydkydyldylydlydyldlyddolydyoyyU2.pptx
Types of control:Qualitative vs Quantitative
HR Introduction Slide (1).pptx on hr intro
340036916-American-Literature-Literary-Period-Overview.ppt
Ôn tập tiếng anh trong kinh doanh nâng cao
Laughter Yoga Basic Learning Workshop Manual

Painless XML Authoring?: How DITA Simplifies XML

  • 1. Painless XML Authoring? How DITA Simplifies XML Bob Doyle [email_address] [email_address] 617-876-5676 Skype: bobdoyle
  • 2. A brief poll. Who’s heard of… Structured writing? Information Mapping? Task-oriented Documentation? vs. ? Minimalism? John Carroll? Single-source publishing? vs. Reuse? Component Content Management? Topic-based authoring? Bob Horn, John Brockmann, JoAnn Hackos, Ginny Redish, Ruth Clark?
  • 3. All heard of DITA? Information Typing Topics: Concept, Task, and Reference DITA Maps DITA Open Toolkit DITA is Simplified XML Specialization
  • 4. Heard of me? Ph.D. Astrophysics, Harvard, 1968 Collaborative Observing Program, NASA Skylab 1970-72 Super8 Sound, 1973-78 Merlin and 5 other computer games– 1977-81 iXO Telecomputer – 1980-87 MacPublisher – 1984-1987 Digital Video Editor, New Media Magazine -1993-1999
  • 6. iXO Telecomputer Computer-initiated dialogues (AI) Yes, No, Help, Repeat keys “ Operators are standing by” Stock trades, airline reservations, bill paying. Hearing-impaired Powered from phone line Venture capital $13 million Never developed the backend database services Huge NOL carry-forward
  • 7. MacPublisher First Desktop Publishing Program 11 th Certified Mac Developer Shipped in 1984 Laserwriter in 1985 First “spot color” text on Apple Imagewriter First rotated text/gaphics Sold 20,000 copies MacIndexer Mac-Hyphen Sold to Letraset in 1987
  • 8. Doing What Recently CEO, skyBuilders.com Editor, CMS Review related websites – CMS Wiki, CMS Forum, CMS News, CMS Calendar, CMS Glossary, CMSML, CMS Boston, Open Internet Lexicon, TaxoTips Founder, CM Professionals Contributing Editor, EContent Magazine Founder, DITA Users related websites – DITA Infocenter, DITA News, DITA Newsletter, DITA Blog, DITA Wiki, and DITA Tutor
  • 9. The First Podcast - 2003 Christopher Lydon (NPR’s “The Connection”) Dave Winer Adam Curry Bloggercon BlogAudio.org Lydon’s “Open Source” Show
  • 10. EContent Magazine Contributing Editor 6 columns per year XML Authoring Tools Review 12 online columns per year EC100 selection
  • 11. Joined OASIS - 2006 Organization for the Advancement of Structured Information Standards Member – DITA Technical Committee Member – Learning and Content SC Member – Help SC Observer – Translation SC Member – Editorial Board Organizer – Boston DITA User Group
  • 12. DITA Users – Launched in March DITA Users is an international membership organization ~400 members from 21 countries. Members learn topic-based structured writing. Author DITA with DITA Storm browser-based editor Deliverables for web (XHTML), print (PDF), Help (Eclipse) from single-source documents. Members have a personal workspace folder. Finished work on web to show colleagues and clients. Member directory has contact information. Discounts on major DITA conferences, on tools (?), on DITA tutorials and workshops, and on the DITA Report.
  • 13. DITA Infocenter – Launched April DITA Infocenter is Eclipse-based Online Help DITA Architectural Specification (1.0 and 1.1) DITA Language Specification (1.0 and 1.1) Open Toolkit User Guide (1.3.1) Full-text search Index of keywords Table of contents Generated from DITA files with Open Toolkit
  • 14. DITA News – Launched June Aggregates blog posts from DITA bloggers. Extensive listings of DITA tools from A to Z. Events calendar with conference listings, Websites, Publications, Webinars. Glossary of DITA terms. Content syndicated to other websites Single-source publishing tools.
  • 15. DITA Blog – Launched July Group blog Anyone may join RSS feeds syndicate to DITA News
  • 16. DITA Wiki – Launched July Resources with comments and discussions. Mediawiki software (Wikipedia) Architectural and Language specifications Vendors and Products Professional Services Edited directly by the vendors User comments People section - major DITA players Glossary of terms
  • 17. DITA Newsletter – Launched September Monthly summary of DITA news Industry mailing list for press releases. DITA Mentor Awards Next month’s events listings Member discount offers
  • 18. DITA Tutor – Launched September Learning management system (Moodle LMS) Self-paced online tutorials Instructor-led online workshops Powerpoint presentations Some with audio recording Recorded webinars Courses in DITA techniques Certificates of completion.
  • 19. DITA User Groups [email_address] http://dita.xml.org/user-groups Encouraging remote attendance Recording meeting presentations Archiving to DITA Tutor Possibly repurpose as eLearning What collaboration tools should we use?
  • 20. Structured Writing – 1960’s and 70’s Structured writing requires an analysis of content and a reorganization into the smallest possible coherent topics. Decades of research on such analysis and organization have been done by Information Mapping™ , who identified common document types, information types, and information blocks (chunks or topics) in use in education and commerce. The reduction in structured authoring time may be offset by the increased time needed to analyze the content and break it into reusable chunks. There is no doubt that granular content, with well-defined purposes for each paragraph and sentence, is easier to author than linear content. But you may need skilled (i.e., more expensive) information developers to chunk your material.
  • 21. Task-oriented Documentation – 1980’s Task-oriented docs have replaced system-oriented or product-oriented docs - the old comprehensive user manual. ROI - The number of calls per month to the help desk on a product will almost certainly change when product documentation is task oriented and minimalist. And task-oriented content can feed directly into help-desk scripts.
  • 22. Minimalism – 1990’s Minimalism aims to provide just what the impatient user is looking for. Remember, the web surfer is always just one click away from going to your competition's website. Your job is to strip away unnecessary content and get to the point. You can measure the return by pre-testing and post-testing content that has been re-architected along minimalist principles. Minimalism appears to promise reduced costs for the simple reason that there is so much less content in well-prepared minimalist material. But it takes talented people to write succinct, action-oriented procedures that get users to understand quickly what they need to know and successfully do it. And minimalist material is best when it is tested for effectiveness, adding to costs.
  • 23. Single-source Publishing – 1990’s The original definition of single-source publishing was providing multiple output formats like Web, Print, and Online Help from the original documents. When you have one source for each piece of content, you get the astonishing ability to change it in one place and have the change propagate everywhere. A product name change becomes much more manageable. Your business-critical marketing messages are standardized everywhere. Some call single source a &quot;single source of truth&quot; because you are assured that your customers are not getting mixed messages that can confuse them, reduce sales, and increase the need for tech support.
  • 24. Single-source plus Reuse Reusable content has a single source, of course, but reuse generally refers to content originally developed for one context that can be reused in another. This requires content that is topic-based and written for reuse by avoiding explicit references to context. The cost savings associated with reuse of content increase greatly when your content goes through a workflow with distinct review and approval stages, for example legal approval. Content that is reused generally can avoid all or most of the extra steps in the workflow that involve accuracy of content. You will still need design approval of the in-context appearance of the reused content.
  • 25. Component Content Management The latest buzzword in CMS is &quot;component.&quot; Most web content management (WCMS) segment content at the web page. While this may be adequate for simple websites written by one or a few content contributors, it is not acceptable for websites whose pages act as portals to diverse kinds of interactive content. Modern corporate pages pull content in from multiple sources. Each content block is filled with a content component managed independently of all the other blocks on the page. A component has its own versioning and scheduling, its own writers, reviewers, and approval process.
  • 26. Topic-based authoring A topic is a unit of information with a title and some form of content, short enough to be specific to a single subject or answer a single question, but long enough to make sense on its own and be authored as a unit. A topic aims to be context-free, so it contains no links to other topics. In DITA, the topic is the basic unit of authoring and of reuse. A topic is a content component
  • 27. Why Concept, Task, and Reference? Remember Macintosh doc guidelines? Learning MacPaint, Using MacPaint, the MacPaint Reference. Today’s O’Reilly Books – Learning PHP, Programming PHP, PHP – the Definitive Reference Concept = What is it? Task = How do I do…? Reference = All the details.
  • 28. What’s a DITA Map? The DITA Map provides context for your context-free topics – the content . You can have many maps, each one arranging the topics for different requirements – a reference manual, a tutorial, a help desk. The map is like a table of contents that rebuilds the book dynamically.
  • 29. What’s the DITA Open Toolkit? The Open Toolkit is an open-source end-to-end single-source publishing system. It takes your topics and your maps and generates multiple output format deliverables, like print (PDF), web (HTML), and Help. It is free and has been integrated into leading DITA editing and CMS tools.
  • 30. Why Simplified XML? DITA is XML. XML is way harder than HTML and most writers want no part of HTML. So how can DITA be easier than XML? Because XML separates content from presentation And it also separates content from structure
  • 31. What Is Content Anyway? It’s not the Presentation or the Structure! Separate Presentation Layer from Content Structure the Content Tag Content with Meaning (semantics) by Metadata
  • 32. Three Kinds of Markup The three layers use different “markup” Style - <font>, <b>, <i> Structure - <p>, <ol> Semantics <name>, <price>, <product>
  • 33. Three Kinds of XML The three layers use different technologies XSLT Stylesheets (CSS) XML Schemas (DTDs) XML/DITA Documents
  • 34. Three Different Professions The three layers are the work of different professionals Designers for Style Architects for Structure Authors for Content and metadata
  • 35. Simplified XML again The DITA Open toolkit is XML with a starter set of stylesheets (XSLTs) and schemas (DTDs) so your organization does not have to invest in months or years of development But simplified can be too simple…
  • 36. DITA is not for writers alone.. Without style designers… (XSLTs) Without structural architects… (DTDs) DITA sucks! It’s like publishing your annual report in Notepad text! Although topics are components, they don’t have the metadata needed to assemble them intelligently.
  • 37. So what’s the benefit for writers? Your work can feed into the dynamic assembly of complex information products Websites, Help systems, Custom Print Documentation, Mobile snippets You are an assembly line writer in the age of information automation! Love it or hate it?
  • 38. Topics are Content Components Even subtopic elements can be reusable components Elements just need unique IDs Then they can be conref ’d (content referenced) which means you can include them by reference in other topics. Specialized topics have metadata created by the structure architects.
  • 39. So what is specialization? You can specialize structures You can specialize element names Then valid topics can be written in DITA-compliant authoring tools without knowing anything about the underlying XML And they can be assembled automatically using the metadata implicit in the specialization.
  • 40. Three examples of specialization Concepts are specialized topics Tasks are specialized topics References are specialized topics By understanding those specializations, you will know how specialization works But remember that specialization is the work of document architects and information designers
  • 41. A close look at a topic A topic has only three required elements. an id attribute in the main topic tag (for reuse) a title a body
  • 42. A close look at a topic… It can have dozens of optional elements, many of which are very familiar HTML elements, like paragraphs <p>, lists <ul>, and tables <table>
  • 43. A close look at a topic… Elements are shown schematically as colored boxes in a hierarchy. They are actually XML tag structures, properly nested and well formed. <topic id=&quot;1&quot;> <title>My Topic</title> <shortdesc>About my topic...</shortdesc> <body> <p>Some content</p> <p>Some more content</p> </body> </topic>
  • 44. The Concept Type The concept type specializes topic element names and topic structure. The root element is renamed concept and the body element is renamed conbody . Any number of paragraphs , lists , tables , etc. may appear, but none of these are allowed after the first section or example . Sections and examples can then appear in any order.
  • 45. The Task Type The task type specializes topic element names and topic structure. The root element is renamed task and the body element is renamed taskbody . One task prerequisite and one context (both specializations of section ) are followed by steps (a specialization of ordered list ). Each step must have a command , then optional info , a step example , choices , and a step result . The set of steps is followed by the task result , examples , and any task postrequisite .
  • 46. The Reference Type The task type specializes topic element names and topic structure. The root element is renamed reference and the body element is renamed refbody . The refbody includes a properties element (a specialization of simpletable ) a three-column table of property types, values, and descriptions. The element refsyn (reference syntax) is a specialization of the section element.
  • 47. Thank you. Contact Bob Doyle [email_address] [email_address] Read my EContent articles www.econtentmag.com/About/AboutAuthor.aspx?AuthorID=155 Please join DITA Users www.ditausers.org/membership/how_to_join Merlin lives! www.theelectronicwizard.com This presentation is online at: www.ditausers.org/users/bobdoyle/DocTrainEast2007.ppt
  • 48. DITA Users Network – 2007 DITA Blog DITA Infocenter DITA News DITA Newsletter DITA Tutor DITA Users DITA Wiki
  • 49. DITA Report - November Coming November 2007 Based on my XML Editors Review Marketplace analysis Vendors and Products Evaluated Strategies from 1 to 100s of writers Online tour of authoring tools
  • 50. XML Editors Altova XML Spy Cladonia Exchanger Stylus Studio SyncRO Soft <oXygen/> Adobe FrameMaker Arbortext Editor XMetal Author Syntext Serna Eight top XML Editors were studied Chosen from 6 5 i n CMS Review Editor Listings P ublished in the June issue of EContent Magazine Extended version - XML Editors Report
  • 51. Which Editors Do You Use? A quick poll of your experience
  • 52. The XML Editors Report Personal use license Corporate license One year of release versions Online consulting included Screen share to look at interfaces
  • 53. CM Pros Best Practices
  • 54. CMS Trends Open Source (and Open Documents) Online (ASPs and Web Services) Offshore? (Globalization) Enabling technologies (XML, Javascript) AJAX, Web 2.0
  • 55. Information Architecture and Content Management. Two Kinds of Information Architecture IA of document sets, books in a library, a website, the World Wide Web – organization, cataloging, metadata tagging, accessibility, findability. IA of a single document - page structure, allowed navigation elements and reusable content components.
  • 56. Defining Content Management What is a CM System? What Is Content Management? What Is Content?
  • 57. What is a CM System? It is humans using computers and software to assist in managing content. It has two main parts: The user interface. The database (content repository). Everything else is magic middleware. It helps manage the content lifecycle.
  • 58. What Is Content Management? Content management is the whole process from creation and capture of original content to the delivery of different versions to many publishing channels: Print Web Cellphone Etc.
  • 59. The Content Lifecycle 7 stages Organize Rules Create Storage Assembly Publish Archive Context Users Content
  • 61. Hi-8 Users Group Funded Videomaker Magazine, Hi-8 Group became Desktop Video Group in 1992
  • 62. HRTV and Quad Sound Harvard-Radcliffe Film Workshop was in the basement of Holmes Hall (North/Pforzheimer House) where the old Radcliffe Radio Station and Morse Music Library were located. In the mid-80’s it became HRTV and the radio broadcast booth and adjoining sound rooms became Quad Sound Studios.
  • 64. Other CMS Review Sites CMS Forum CMS Wiki CMSML CMS News CMS Calendar CMS Glossary CMS Boston Memography Open Internet Lexicon TaxoTips List-2-Web
  • 66. Finding a CMS The CMSML project at CMS Review and CM Pros Select two CMS or enter search terms to find CMS that match your criteria. The directory is a faceted classification scheme. Click compare to get the results below...
  • 67. CM Professionals Nearly 1000 members in 2006 Website (7/10 Google PageRank) Benefits - Mail, Member Directory Glossary, Resource Library, Calendar Communi ties - CMSML, DITA, Global News, Blog aggregation Globalization, Personalization
  • 69. CM Pros Member Directory
  • 71. CM Pros Videos Eighty hours of video from Gilbane Conferences, IA Summit, OSCOM, Bloggercons at Harvard. Bob Boiko interviews Shino
  • 72. CM Pros Communities CMS Markup Language (and Faceted CMS Directory) Globalization – website in 10 languages (translations by volunteers) DITA (JoAnn Hackos, Scott Abel, others)
  • 73. DITA Island Second Life meetings on DITA