SlideShare una empresa de Scribd logo
1 de 33
Descargar para leer sin conexión
(Almost) Four Years On:
Metrics, ROI, and Other
Stories from a Mature DITA
CMS Installation
Keith Schengili-Roberts | November 15, 2010
Agenda

• Intro + ROI
• Things We Didn’t Expect
• Measuring Productivity: Uses of Metadata




    2
Who is This Guy?

                   Keith Schengili-Roberts
                   •   Manager for documentation and
                       localization for AMD’s Professional
                       Graphics division (formerly ATI)
                        Prior to becoming manager of the
                         group, was its information architect
                   •   Lecturer at University of Toronto’s
                       Professional Learning Center since
                       1999, teaching courses on information
                       architecture and content management
                       (sample slide decks available from:
                       http://www.infoarchcourse.com/)
                   •   Author of four titles on Internet
                       technologies; last title was “Core CSS,
                       2nd Edition” (2001)

    3
ROI Executive Summary

Proven return on investment (ROI) benefits from
using a CMS-based DITA over the previous toolchain:
    Productivity/output increases
     – Somewhere between 2.3 and 3 times more efficient
   Can “do more with what we’ve already got”
     – Minimalism and content re-use goes a long way
     – We have fewer writers than when we started while our
       output rate continues to increase
   Localization cost savings
     – Localization budget is now less than half of what we
       needed from the year before we started using the DITA
       CMS
     – We are much more productive
     4
What We Do

Documentation & Localization Group at AMD's Graphics Product
  Group (GPG)
    Formerly ATI
    Based in Markham, Ontario
    4 writers, 2 process engineers, 2 localizers, 1 manager
    CMS: DITA CMS from Ixiasoft (www.ixiasoft.com)
Responsible for:
    End-user documentation, including online help (20%)
    Engineering documentation for ODM/OEM partners (60%)
    Technical training documentation for partners (20%)
    Localize in up to 25 languages (mostly end-user and UI)
    Primary outputs are PDF and XHTML


      5
Where We Started (i.e., “The Bad Old Days”)

Circa 2003-2006:
• Used unstructured FrameMaker
    Localization costs very high
    Code page issues made localization QA work hard
    Could not reliably keep in sync with major software releases
     (monthly cadence required for online help; could only do it twice
     a year)
Writers were deeply siloed
    Very little content shared
    Content re-use (especially between different docs) very low
    Output was efficient but quality was highly variable




      6
Where We Are Now

Have been using Ixiasoft’s DITA CMS in production since
February 2007
Have published more than 2,200 documents in that time
    46% in English
    54% in the languages to which we localize (21 maximum)


Writers and the documentation process are more nimble
    Any writer can take on another’s projects
    Content re-use rate is good (slightly more than 50% monthly)
    Quality is uniformly better; re-used topics are edited topics


Localization process is streamlined, with more time now
available to focus on QA than on administration or fixing
formatting issues


      7
Getting ROI by Doing More with What We’ve Already Got

• Using the old toolchain, we spent about 50% of our time
  formatting content; this equates to an almost equal boost in
  productivity using the DITA CMS.
• We automate things that can (and should) be automated; no
  more TOCs or Indexes built by hand.
• Through attrition, we have fewer personnel writing/localizing
  content; despite this, our output rate has increased.
    An information architecture content audit of existing materials
     emphasized minimalism and re-use within and between
     document types.
    Content re-use is considerable; now, de-siloed writers are more
     flexible on what they can work on.
    We continue our effort to find out what customers find useful,
     and to give them only the information they require.

      8
ROI: Doing More with Less

Comparative numbers from 2007:




• Numbers show equivalent work on engineering docs (size
  types/sizes of docs/product release cycle)
• DITA CMS made us faster
• More than doubled output using the same headcount while
  taking on an expanded range of document types




     9
ROI: Doing More with Less (cont.)

What’s happened since 2007?




     10
ROI: Doing More with Less (cont.)

In 2009, 4 writers were responsible for 366 docs.
•   On average, each writer produced 91.5 docs in a year = ~23 per
    writer per quarter
     This figure does include revisions; however, on average, we do same
      number of revisions as we did under the old toolchain (we just do them
      faster).
•   Compare this to some roughly equivalent numbers from another
    Tech Writing team cover a similar subject area using our old
    toolchain:
     They produced 360 docs using 9 over the course of a year; their docs
      roughly the same size, type and having a similar release cadence
     This = 40 docs per writer per year, or 10 per writer per quarter
        – By these numbers, use of the DITA CMS improves efficiency by 2.3 times
          (your own results may vary)

•   The two localization coordinators were responsible for producing
    432 docs in the system during 2009.


       11
ROI: Localization Cost Savings

• Content re-use in English corresponds directly to
  translated content re-use
• Eliminated desktop publishing (DTP) charges
• As a result, we are able to produce publications
  more quickly and reliably and less expensively
  than with our old toolchain:
   One example is our Catalyst Control Center online help:
    prior to the DITA CMS, we could only hope to do this at
    most every 6 months; now, we can keep up with the
    monthly software release cycle.




    12
CMS-based DITA and Localization Costs




                                                  CMS ROI
               “Bad Old Days”

                  Content audit +
                  Single-sourcing



Blue line= localization budget for quarter; Red line= actual localization spend
Our annual localization budget is now 2.5 times less than the year before we started using
the CMS (2006)
• DITA CMS has more than paid for itself based only on reduced localization costs
The volume of localized content has increased over this time period
        13
DITA Advantages from a Writer’s Perspective

Moving and implementing DITA is typically a
management decision, but there are advantages for
the writers:
   Learning a new and valued skill (I've had two writers
    hired out from under me by another firm looking to "do
    DITA").
   As content re-use increases over time, the writers act
    more as editors, so have a higher "value-add" to the
    content process.
   Significant topic re-use means that writers learn more
    about other subjects using other writers’ topics,
    effectively de-siloing the writing team.
   Programmatic skills increasingly called into play because
    there is a need for people who understand XSL and text-
    parsing languages (such as Python) and also understand
    publishing.
    14
Things We Didn’t Expect

• Need for a “house” DITA Style Guide
   Also found ways to help enforce it
• Conrefs vs. Cloning
• More nimble options available for doing localization
• Use of tracking-based metadata allows us to do
  thorough productivity measures
   And allows us to measure useful things we had not
    initially anticipated
How Much DITA Do You Need?

In terms of the number of tags
you need to use, it may be less
than you think:
   Our initial approach was
    evolutionary; writers could use
    any tag they felt necessary, and
    over time DITA tagging styles
    were established and made
    uniform (DITA Style Guide).
   Using fewer tags decreases
    formatting issues/clashes when
    creating XSL output types.
   In all, we actively use fewer than
    half of all DITA 1.1 tags.


    16
Cloud of Relative Tag Usage




     •   67 tags displayed, with a threshold of +20 min. usage
     •   Tags not included because they are auto-populated/included in
         our topic templates: othermeta, metadata, prolog, searchtitle,
         shortdesc, titlealts, navtitle
    17
     •   Created using “Wordle” from www.wordle.net
Creating a DITA Style Guide

A recommendation for any tech docs group that uses
DITA extensively:
   Helps new writers/contributors come up to speed
   Usefully narrows the scope of the XSL work that needs to
    be done
   Many things are “legal” in DITA but may be poor from a
    “house style” standpoint, for example:
     – Can have unformatted block content between a header and a table
       in a section
     – Tables and figures do not have to have a title
     – Can have unlimited nested lists
     – Alpha lists can contain more than 26 items
     – Lists can contain only a single item



    18
Schematron Can Help Enforce DITA Style

What is Schematron? “Schematron is a rule-based validation
language for making assertions about the presence or absence
of patterns in XML trees.” (www.wikipedia.org)
We use Schematron to point out to the writers potential
errors/lapses in our DITA House Style:
    Text between a section and table not wrapped in block tags:




    A list ought to have more than one item (otherwise, why make it
     a list?):




     19
XSL Can Help Enforce DITA House Style

We have a DITA house style that says nested lists should be no
more than two levels deep.
    Here’s Schematron doing it’s job:




    And here is the result if you try to output it:




     20
Conrefs vs. Cloning

At a very early stage we decided not to use conrefs in our DITA
   content
   • Made localization programmatically complicated/inefficient
       • Creating a localization kit would mean finding all conrefs in a doc
         (however many levels they are nested) and then “flattening” them;
         leads to inefficient segment-matching
   • Did not seem cost-effective from an author’s perspective
       • Would seem to limit reuse as conref targets become “fixed”; dare
         not change without affecting many docs
       • Searching and then defining a single phrase or paragraph to reuse
         not always an efficient use of time




     21
Conrefs vs. Cloning

• We instead chose a “clone” approach to topic re-use:
   • Essentially, make a copy of an existing topic and use only the
     parts that you need in your current document
   • Original topic and cloned are completely separate (though
     trackable; parent/child relationship is retained in CMS)
   • Cloning is only done when the amount of change is sufficient
     that the original topic cannot accommodate it
   • Writers can more freely re-use existing topics for their own
     needs
   • When a localization kit is made, the segment matching process
     is efficient




     22
Nimble Localization Processes with DITA XML

Under the old toolchain, localizing a 200+ page document to a
single language within a week (without huge expense) was
impossible.
DITA XML allows us to be more nimble: for critical large
documents, we can send the localization firm finished “parts” as
we get them (“70/20/10”):
    When roughly 70% of a large document is done, we send it off
     for translation, followed a week or two later with another 20%
     of new and updated material, then the last 10% when we
     complete it.
    While this process does cost more than sending in a whole
     document at once, it reduces the turnaround time from weeks
     to days, and quality is much improved because it is not done in
     a rush.
    This approach was simply not feasible using our old toolchain;
     ultimately, the new toolchain is still cheaper and much faster.


     23
Measuring Productivity: Uses of Metadata

There are three main purposes for metadata:
    Retrieval
    Re-use
    Tracking
• Everyone who has used a search engine is familiar with
  the “Retrieval” part.
• Authors can add their own metadata to topics to aid in
  later retrieval for re-use.
    Topic and map dependencies can be checked, and
     associated topics re-used in other publications.
Tracking Metadata

Tracking metadata (in our case, mainly dates, author, and
topic/map status) is used for understanding trends and
managing workflow.
The types of questions we can readily answer include:
    Who created the content (author)?
    When was it created (date)?
    Who modified it (editor)?
    Who reviewed it (reviewer/approver)?
    Where has it been re-used (map relation)?
    Has it been published or translated (status/language)?




     25
How We Measure Productivity

Metric we use is a combination of topics created + topics
modified in a monthly/quarterly timeframe:
    Each new topic created counts as 1.
    Modified topics are also counted, though again only as 1.
    Subsequent revisions to the same topic in a given
     timeframe are not counted.
Provides us with a very good view of ongoing work, and
the numbers align with known product release cycles.
Works both as an aggregate measure (total output per
month), and as a measure of a writer’s individual
productivity.
    Maps are also tracked, but are not as good for measuring
     productivity since they come in many sizes and have widely
     varying development timelines.

     26
Topics Created/Modified (Monthly)




   27
Topic Production Matches Product Cadence



                                                                                       Product
                        Product                         Product                      Release Cycle
                      Release Cycle                   Release Cycle                       #3
                           #1                              #2




                                                                                                   Secondary Peak
                                                                    Secondary Peak
                                     Secondary Peak




                                                                                       Main Peak
                                                        Main Peak
                         Main Peak




  • Regular peak of production in Q3, typically followed by secondary peak in Q1


   28
Localization Segments Auto-translated within CMS Monthly


• Portion in orange is
  the percentage
  that were 100%
  matches, and were
  never sent to a
  localization vendor
  = pure ROI!
• From July 2008 to
  July 2009, an avg.
  of 54% of
  segments were
  auto-translated
  within the system.



     29
Sample Topic Reuse Rate (Monthly)




 From Jan 2008 to June 2009, average monthly topic reuse rate = 53.53%

    30
An Interesting Trend: Topic Ratios




Except in year one, reference topics steadily make up ~74% of all topics used

      31
What is the Average Size of a Topic?

Maps avg. = 3.47 kb
Concepts avg. = 2.46 kb
References avg. = 7.88 kb
Tasks avg. = 3.20 kb


1 byte = 1 character
1000 bytes (1 kb) = 1000 characters


•   Concepts avg. 0.65 of a page of
    Lorem ipsum text in Word
•   References avg. 2.6 pages
        Smallest: half a page
        Largest: ~200 pages
•   Tasks avg. 1 page



         32
Questions & Answers




   33

Más contenido relacionado

La actualidad más candente

Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
Troubleshooting: The Two Laws - IXIASOFT User Conference 2016Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
Troubleshooting: The Two Laws - IXIASOFT User Conference 2016IXIASOFT
 
Agile Content Development and the IXIASOFT DITA CMS
Agile Content Development and the IXIASOFT DITA CMSAgile Content Development and the IXIASOFT DITA CMS
Agile Content Development and the IXIASOFT DITA CMSIXIASOFT
 
The Evolution of DITAs
The Evolution of DITAsThe Evolution of DITAs
The Evolution of DITAsIXIASOFT
 
The DITA Iceberg, DITA Europe 2016
The DITA Iceberg, DITA Europe 2016The DITA Iceberg, DITA Europe 2016
The DITA Iceberg, DITA Europe 2016IXIASOFT
 
Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...
Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...
Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...IXIASOFT
 
Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...
Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...
Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...Jack Molisani
 
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...IXIASOFT
 
How to Optimize Your Metadata and Taxonomy
How to Optimize Your Metadata and TaxonomyHow to Optimize Your Metadata and Taxonomy
How to Optimize Your Metadata and TaxonomyIXIASOFT
 
What They Won't Tell You About DITA
What They Won't Tell You About DITAWhat They Won't Tell You About DITA
What They Won't Tell You About DITAAlan Houser
 
Painless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XMLPainless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XMLScott Abel
 
Zen and Enterprise Architecture
Zen and Enterprise ArchitectureZen and Enterprise Architecture
Zen and Enterprise ArchitectureRichard Green
 
Anticipating Lightweight DITA
Anticipating Lightweight DITAAnticipating Lightweight DITA
Anticipating Lightweight DITAdclsocialmedia
 
IBM Connect 2017: Refresh and Extend IBM Domino Applications
IBM Connect 2017: Refresh and Extend IBM Domino ApplicationsIBM Connect 2017: Refresh and Extend IBM Domino Applications
IBM Connect 2017: Refresh and Extend IBM Domino ApplicationsEd Brill
 
DITA Quick Start: System Architecture of a Basic DITA Toolset
DITA Quick Start: System Architecture of a Basic DITA ToolsetDITA Quick Start: System Architecture of a Basic DITA Toolset
DITA Quick Start: System Architecture of a Basic DITA ToolsetSuite Solutions
 
Records Management in SharePoint
Records Management in SharePointRecords Management in SharePoint
Records Management in SharePointRegroove
 
ECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCB
ECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCBECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCB
ECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCBEMA Design Automation
 

La actualidad más candente (20)

Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
Troubleshooting: The Two Laws - IXIASOFT User Conference 2016Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
Troubleshooting: The Two Laws - IXIASOFT User Conference 2016
 
Agile Content Development and the IXIASOFT DITA CMS
Agile Content Development and the IXIASOFT DITA CMSAgile Content Development and the IXIASOFT DITA CMS
Agile Content Development and the IXIASOFT DITA CMS
 
The Evolution of DITAs
The Evolution of DITAsThe Evolution of DITAs
The Evolution of DITAs
 
The DITA Iceberg, DITA Europe 2016
The DITA Iceberg, DITA Europe 2016The DITA Iceberg, DITA Europe 2016
The DITA Iceberg, DITA Europe 2016
 
Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...
Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...
Improve your Chances for Documentation Success with DITA and a CCMS LavaCon L...
 
Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...
Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...
Keith Schengili-Roberts: Improve Your Chances for Documentation Success with ...
 
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...
 
Product Brochure
Product BrochureProduct Brochure
Product Brochure
 
How to Optimize Your Metadata and Taxonomy
How to Optimize Your Metadata and TaxonomyHow to Optimize Your Metadata and Taxonomy
How to Optimize Your Metadata and Taxonomy
 
What They Won't Tell You About DITA
What They Won't Tell You About DITAWhat They Won't Tell You About DITA
What They Won't Tell You About DITA
 
Painless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XMLPainless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XML
 
Zen and Enterprise Architecture
Zen and Enterprise ArchitectureZen and Enterprise Architecture
Zen and Enterprise Architecture
 
Anticipating Lightweight DITA
Anticipating Lightweight DITAAnticipating Lightweight DITA
Anticipating Lightweight DITA
 
IBM Connect 2017: Refresh and Extend IBM Domino Applications
IBM Connect 2017: Refresh and Extend IBM Domino ApplicationsIBM Connect 2017: Refresh and Extend IBM Domino Applications
IBM Connect 2017: Refresh and Extend IBM Domino Applications
 
The Trip to DITA
The Trip to DITAThe Trip to DITA
The Trip to DITA
 
Introduction to DITA
Introduction to DITAIntroduction to DITA
Introduction to DITA
 
DITA Quick Start: System Architecture of a Basic DITA Toolset
DITA Quick Start: System Architecture of a Basic DITA ToolsetDITA Quick Start: System Architecture of a Basic DITA Toolset
DITA Quick Start: System Architecture of a Basic DITA Toolset
 
Repairing with DITA - Don Day
Repairing with DITA -  Don DayRepairing with DITA -  Don Day
Repairing with DITA - Don Day
 
Records Management in SharePoint
Records Management in SharePointRecords Management in SharePoint
Records Management in SharePoint
 
ECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCB
ECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCBECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCB
ECAD MCAD Design Data Management with PTC Windchill and Cadence Allegro PCB
 

Similar a (Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CMS Installation

Is DITA Right for You? - STC Summit 2017
Is DITA Right for You? - STC Summit 2017Is DITA Right for You? - STC Summit 2017
Is DITA Right for You? - STC Summit 2017IXIASOFT
 
Understanding and Communicating the Financial Impact of XML & DITA
Understanding and Communicating the Financial Impact of XML & DITAUnderstanding and Communicating the Financial Impact of XML & DITA
Understanding and Communicating the Financial Impact of XML & DITAScott Abel
 
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and FundamentalsSuccess Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and FundamentalsScott Abel
 
Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016
Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016
Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016IXIASOFT
 
Two to Tango - Agile Meets DITA
Two to Tango - Agile Meets DITATwo to Tango - Agile Meets DITA
Two to Tango - Agile Meets DITANabayan Roy
 
Agile Meets DITA: Developing User Documentation in an Agile Environment
Agile Meets DITA: Developing User Documentation in an Agile EnvironmentAgile Meets DITA: Developing User Documentation in an Agile Environment
Agile Meets DITA: Developing User Documentation in an Agile EnvironmentNabayan Roy
 
Using Markdown and Lightweight DITA in a Collaborative Environment
Using Markdown and Lightweight DITA in a Collaborative EnvironmentUsing Markdown and Lightweight DITA in a Collaborative Environment
Using Markdown and Lightweight DITA in a Collaborative EnvironmentIXIASOFT
 
From Planning to Publishing: How Business Objects Migrated Documentation to D...
From Planning to Publishing: How Business Objects Migrated Documentation to D...From Planning to Publishing: How Business Objects Migrated Documentation to D...
From Planning to Publishing: How Business Objects Migrated Documentation to D...Scott Abel
 
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...LavaConConference
 
DITA and Metadata on an Enterprise Scale
DITA and Metadata on an Enterprise ScaleDITA and Metadata on an Enterprise Scale
DITA and Metadata on an Enterprise ScaleKristen Eberlein
 
Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...
Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...
Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...Daniel Zivkovic
 
LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...
LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...
LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...Jack Molisani
 
Reports and DITA Metrics IXIASOFT User Conference 2016
Reports and DITA Metrics IXIASOFT User Conference 2016Reports and DITA Metrics IXIASOFT User Conference 2016
Reports and DITA Metrics IXIASOFT User Conference 2016IXIASOFT
 
DITA for Small Teams Workshop (Tekom 2017)
DITA for Small Teams Workshop (Tekom 2017)DITA for Small Teams Workshop (Tekom 2017)
DITA for Small Teams Workshop (Tekom 2017)Contrext Solutions
 
Building An XML Publishing System With DITA
Building An XML Publishing System With DITABuilding An XML Publishing System With DITA
Building An XML Publishing System With DITAScott Abel
 
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why'sScott Abel
 
Sprinting to Success: Why Agile and DITA Work So Well Together
Sprinting to Success: Why Agile and DITA Work So Well TogetherSprinting to Success: Why Agile and DITA Work So Well Together
Sprinting to Success: Why Agile and DITA Work So Well TogetherIXIASOFT
 
apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...
apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...
apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...apidays
 

Similar a (Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CMS Installation (20)

Is DITA Right for You? - STC Summit 2017
Is DITA Right for You? - STC Summit 2017Is DITA Right for You? - STC Summit 2017
Is DITA Right for You? - STC Summit 2017
 
Understanding and Communicating the Financial Impact of XML & DITA
Understanding and Communicating the Financial Impact of XML & DITAUnderstanding and Communicating the Financial Impact of XML & DITA
Understanding and Communicating the Financial Impact of XML & DITA
 
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and FundamentalsSuccess Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
 
Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016
Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016
Metrics for continual improvements - Nolwenn Kerzreho LavaconDublin2016
 
Two to Tango - Agile Meets DITA
Two to Tango - Agile Meets DITATwo to Tango - Agile Meets DITA
Two to Tango - Agile Meets DITA
 
Agile Meets DITA: Developing User Documentation in an Agile Environment
Agile Meets DITA: Developing User Documentation in an Agile EnvironmentAgile Meets DITA: Developing User Documentation in an Agile Environment
Agile Meets DITA: Developing User Documentation in an Agile Environment
 
DITA Interoperability
DITA InteroperabilityDITA Interoperability
DITA Interoperability
 
Using Markdown and Lightweight DITA in a Collaborative Environment
Using Markdown and Lightweight DITA in a Collaborative EnvironmentUsing Markdown and Lightweight DITA in a Collaborative Environment
Using Markdown and Lightweight DITA in a Collaborative Environment
 
From Planning to Publishing: How Business Objects Migrated Documentation to D...
From Planning to Publishing: How Business Objects Migrated Documentation to D...From Planning to Publishing: How Business Objects Migrated Documentation to D...
From Planning to Publishing: How Business Objects Migrated Documentation to D...
 
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
 
DITA and Metadata on an Enterprise Scale
DITA and Metadata on an Enterprise ScaleDITA and Metadata on an Enterprise Scale
DITA and Metadata on an Enterprise Scale
 
Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...
Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...
Canadian Experts Discuss Modern Data Stacks and Cloud Computing for 5 Years o...
 
LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...
LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...
LavaCon 2017 - Implementing a Customer-driven Transition to DITA Content: A S...
 
Reports and DITA Metrics IXIASOFT User Conference 2016
Reports and DITA Metrics IXIASOFT User Conference 2016Reports and DITA Metrics IXIASOFT User Conference 2016
Reports and DITA Metrics IXIASOFT User Conference 2016
 
DITA for Small Teams Workshop (Tekom 2017)
DITA for Small Teams Workshop (Tekom 2017)DITA for Small Teams Workshop (Tekom 2017)
DITA for Small Teams Workshop (Tekom 2017)
 
Building An XML Publishing System With DITA
Building An XML Publishing System With DITABuilding An XML Publishing System With DITA
Building An XML Publishing System With DITA
 
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
 
Sprinting to Success: Why Agile and DITA Work So Well Together
Sprinting to Success: Why Agile and DITA Work So Well TogetherSprinting to Success: Why Agile and DITA Work So Well Together
Sprinting to Success: Why Agile and DITA Work So Well Together
 
Real world rm in share point 2013
Real world rm in share point 2013Real world rm in share point 2013
Real world rm in share point 2013
 
apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...
apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...
apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, ...
 

Más de Keith Schengili-Roberts

Information Architecture - Part 1 - Spring 2013 - Class 1
Information Architecture - Part 1 - Spring 2013 - Class 1Information Architecture - Part 1 - Spring 2013 - Class 1
Information Architecture - Part 1 - Spring 2013 - Class 1Keith Schengili-Roberts
 
Information Architecture: Part 2 - Spring 2013 - Class 4
Information Architecture: Part 2 - Spring 2013 - Class 4Information Architecture: Part 2 - Spring 2013 - Class 4
Information Architecture: Part 2 - Spring 2013 - Class 4Keith Schengili-Roberts
 
Information Architecture - Part 2 - Spring 2013 - Class 3
Information Architecture - Part 2 - Spring 2013 - Class 3Information Architecture - Part 2 - Spring 2013 - Class 3
Information Architecture - Part 2 - Spring 2013 - Class 3Keith Schengili-Roberts
 
Information Architecture: Part 2 - Spring 2013 - Class 2
Information Architecture: Part 2 - Spring 2013 - Class 2Information Architecture: Part 2 - Spring 2013 - Class 2
Information Architecture: Part 2 - Spring 2013 - Class 2Keith Schengili-Roberts
 
Information Architecture Course Part 2 - Spring 2013 - Class 1
Information Architecture Course Part 2 - Spring 2013 - Class 1Information Architecture Course Part 2 - Spring 2013 - Class 1
Information Architecture Course Part 2 - Spring 2013 - Class 1Keith Schengili-Roberts
 

Más de Keith Schengili-Roberts (6)

The Future of DITA
The Future of DITAThe Future of DITA
The Future of DITA
 
Information Architecture - Part 1 - Spring 2013 - Class 1
Information Architecture - Part 1 - Spring 2013 - Class 1Information Architecture - Part 1 - Spring 2013 - Class 1
Information Architecture - Part 1 - Spring 2013 - Class 1
 
Information Architecture: Part 2 - Spring 2013 - Class 4
Information Architecture: Part 2 - Spring 2013 - Class 4Information Architecture: Part 2 - Spring 2013 - Class 4
Information Architecture: Part 2 - Spring 2013 - Class 4
 
Information Architecture - Part 2 - Spring 2013 - Class 3
Information Architecture - Part 2 - Spring 2013 - Class 3Information Architecture - Part 2 - Spring 2013 - Class 3
Information Architecture - Part 2 - Spring 2013 - Class 3
 
Information Architecture: Part 2 - Spring 2013 - Class 2
Information Architecture: Part 2 - Spring 2013 - Class 2Information Architecture: Part 2 - Spring 2013 - Class 2
Information Architecture: Part 2 - Spring 2013 - Class 2
 
Information Architecture Course Part 2 - Spring 2013 - Class 1
Information Architecture Course Part 2 - Spring 2013 - Class 1Information Architecture Course Part 2 - Spring 2013 - Class 1
Information Architecture Course Part 2 - Spring 2013 - Class 1
 

Último

DevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenDevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenHervé Boutemy
 
Story boards and shot lists for my a level piece
Story boards and shot lists for my a level pieceStory boards and shot lists for my a level piece
Story boards and shot lists for my a level piececharlottematthew16
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLScyllaDB
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxNavinnSomaal
 
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostLeverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostZilliz
 
AI as an Interface for Commercial Buildings
AI as an Interface for Commercial BuildingsAI as an Interface for Commercial Buildings
AI as an Interface for Commercial BuildingsMemoori
 
Vector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector DatabasesVector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector DatabasesZilliz
 
Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Mattias Andersson
 
Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!Manik S Magar
 
Unraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdfUnraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdfAlex Barbosa Coqueiro
 
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...Patryk Bandurski
 
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada
 
My Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationMy Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationRidwan Fadjar
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii SoldatenkoFwdays
 
Install Stable Diffusion in windows machine
Install Stable Diffusion in windows machineInstall Stable Diffusion in windows machine
Install Stable Diffusion in windows machinePadma Pradeep
 
Designing IA for AI - Information Architecture Conference 2024
Designing IA for AI - Information Architecture Conference 2024Designing IA for AI - Information Architecture Conference 2024
Designing IA for AI - Information Architecture Conference 2024Enterprise Knowledge
 
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Mark Simos
 
Powerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time ClashPowerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time Clashcharlottematthew16
 
Bun (KitWorks Team Study 노별마루 발표 2024.4.22)
Bun (KitWorks Team Study 노별마루 발표 2024.4.22)Bun (KitWorks Team Study 노별마루 발표 2024.4.22)
Bun (KitWorks Team Study 노별마루 발표 2024.4.22)Wonjun Hwang
 

Último (20)

DevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenDevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache Maven
 
Story boards and shot lists for my a level piece
Story boards and shot lists for my a level pieceStory boards and shot lists for my a level piece
Story boards and shot lists for my a level piece
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQL
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptx
 
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostLeverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
 
AI as an Interface for Commercial Buildings
AI as an Interface for Commercial BuildingsAI as an Interface for Commercial Buildings
AI as an Interface for Commercial Buildings
 
Vector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector DatabasesVector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector Databases
 
Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?
 
Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!
 
Unraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdfUnraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdf
 
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
 
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
 
My Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationMy Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 Presentation
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko
 
Install Stable Diffusion in windows machine
Install Stable Diffusion in windows machineInstall Stable Diffusion in windows machine
Install Stable Diffusion in windows machine
 
DMCC Future of Trade Web3 - Special Edition
DMCC Future of Trade Web3 - Special EditionDMCC Future of Trade Web3 - Special Edition
DMCC Future of Trade Web3 - Special Edition
 
Designing IA for AI - Information Architecture Conference 2024
Designing IA for AI - Information Architecture Conference 2024Designing IA for AI - Information Architecture Conference 2024
Designing IA for AI - Information Architecture Conference 2024
 
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
 
Powerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time ClashPowerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time Clash
 
Bun (KitWorks Team Study 노별마루 발표 2024.4.22)
Bun (KitWorks Team Study 노별마루 발표 2024.4.22)Bun (KitWorks Team Study 노별마루 발표 2024.4.22)
Bun (KitWorks Team Study 노별마루 발표 2024.4.22)
 

(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CMS Installation

  • 1. (Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CMS Installation Keith Schengili-Roberts | November 15, 2010
  • 2. Agenda • Intro + ROI • Things We Didn’t Expect • Measuring Productivity: Uses of Metadata 2
  • 3. Who is This Guy? Keith Schengili-Roberts • Manager for documentation and localization for AMD’s Professional Graphics division (formerly ATI)  Prior to becoming manager of the group, was its information architect • Lecturer at University of Toronto’s Professional Learning Center since 1999, teaching courses on information architecture and content management (sample slide decks available from: http://www.infoarchcourse.com/) • Author of four titles on Internet technologies; last title was “Core CSS, 2nd Edition” (2001) 3
  • 4. ROI Executive Summary Proven return on investment (ROI) benefits from using a CMS-based DITA over the previous toolchain:  Productivity/output increases – Somewhere between 2.3 and 3 times more efficient  Can “do more with what we’ve already got” – Minimalism and content re-use goes a long way – We have fewer writers than when we started while our output rate continues to increase  Localization cost savings – Localization budget is now less than half of what we needed from the year before we started using the DITA CMS – We are much more productive 4
  • 5. What We Do Documentation & Localization Group at AMD's Graphics Product Group (GPG)  Formerly ATI  Based in Markham, Ontario  4 writers, 2 process engineers, 2 localizers, 1 manager  CMS: DITA CMS from Ixiasoft (www.ixiasoft.com) Responsible for:  End-user documentation, including online help (20%)  Engineering documentation for ODM/OEM partners (60%)  Technical training documentation for partners (20%)  Localize in up to 25 languages (mostly end-user and UI)  Primary outputs are PDF and XHTML 5
  • 6. Where We Started (i.e., “The Bad Old Days”) Circa 2003-2006: • Used unstructured FrameMaker  Localization costs very high  Code page issues made localization QA work hard  Could not reliably keep in sync with major software releases (monthly cadence required for online help; could only do it twice a year) Writers were deeply siloed  Very little content shared  Content re-use (especially between different docs) very low  Output was efficient but quality was highly variable 6
  • 7. Where We Are Now Have been using Ixiasoft’s DITA CMS in production since February 2007 Have published more than 2,200 documents in that time  46% in English  54% in the languages to which we localize (21 maximum) Writers and the documentation process are more nimble  Any writer can take on another’s projects  Content re-use rate is good (slightly more than 50% monthly)  Quality is uniformly better; re-used topics are edited topics Localization process is streamlined, with more time now available to focus on QA than on administration or fixing formatting issues 7
  • 8. Getting ROI by Doing More with What We’ve Already Got • Using the old toolchain, we spent about 50% of our time formatting content; this equates to an almost equal boost in productivity using the DITA CMS. • We automate things that can (and should) be automated; no more TOCs or Indexes built by hand. • Through attrition, we have fewer personnel writing/localizing content; despite this, our output rate has increased.  An information architecture content audit of existing materials emphasized minimalism and re-use within and between document types.  Content re-use is considerable; now, de-siloed writers are more flexible on what they can work on.  We continue our effort to find out what customers find useful, and to give them only the information they require. 8
  • 9. ROI: Doing More with Less Comparative numbers from 2007: • Numbers show equivalent work on engineering docs (size types/sizes of docs/product release cycle) • DITA CMS made us faster • More than doubled output using the same headcount while taking on an expanded range of document types 9
  • 10. ROI: Doing More with Less (cont.) What’s happened since 2007? 10
  • 11. ROI: Doing More with Less (cont.) In 2009, 4 writers were responsible for 366 docs. • On average, each writer produced 91.5 docs in a year = ~23 per writer per quarter  This figure does include revisions; however, on average, we do same number of revisions as we did under the old toolchain (we just do them faster). • Compare this to some roughly equivalent numbers from another Tech Writing team cover a similar subject area using our old toolchain:  They produced 360 docs using 9 over the course of a year; their docs roughly the same size, type and having a similar release cadence  This = 40 docs per writer per year, or 10 per writer per quarter – By these numbers, use of the DITA CMS improves efficiency by 2.3 times (your own results may vary) • The two localization coordinators were responsible for producing 432 docs in the system during 2009. 11
  • 12. ROI: Localization Cost Savings • Content re-use in English corresponds directly to translated content re-use • Eliminated desktop publishing (DTP) charges • As a result, we are able to produce publications more quickly and reliably and less expensively than with our old toolchain:  One example is our Catalyst Control Center online help: prior to the DITA CMS, we could only hope to do this at most every 6 months; now, we can keep up with the monthly software release cycle. 12
  • 13. CMS-based DITA and Localization Costs CMS ROI “Bad Old Days” Content audit + Single-sourcing Blue line= localization budget for quarter; Red line= actual localization spend Our annual localization budget is now 2.5 times less than the year before we started using the CMS (2006) • DITA CMS has more than paid for itself based only on reduced localization costs The volume of localized content has increased over this time period 13
  • 14. DITA Advantages from a Writer’s Perspective Moving and implementing DITA is typically a management decision, but there are advantages for the writers:  Learning a new and valued skill (I've had two writers hired out from under me by another firm looking to "do DITA").  As content re-use increases over time, the writers act more as editors, so have a higher "value-add" to the content process.  Significant topic re-use means that writers learn more about other subjects using other writers’ topics, effectively de-siloing the writing team.  Programmatic skills increasingly called into play because there is a need for people who understand XSL and text- parsing languages (such as Python) and also understand publishing. 14
  • 15. Things We Didn’t Expect • Need for a “house” DITA Style Guide  Also found ways to help enforce it • Conrefs vs. Cloning • More nimble options available for doing localization • Use of tracking-based metadata allows us to do thorough productivity measures  And allows us to measure useful things we had not initially anticipated
  • 16. How Much DITA Do You Need? In terms of the number of tags you need to use, it may be less than you think:  Our initial approach was evolutionary; writers could use any tag they felt necessary, and over time DITA tagging styles were established and made uniform (DITA Style Guide).  Using fewer tags decreases formatting issues/clashes when creating XSL output types.  In all, we actively use fewer than half of all DITA 1.1 tags. 16
  • 17. Cloud of Relative Tag Usage • 67 tags displayed, with a threshold of +20 min. usage • Tags not included because they are auto-populated/included in our topic templates: othermeta, metadata, prolog, searchtitle, shortdesc, titlealts, navtitle 17 • Created using “Wordle” from www.wordle.net
  • 18. Creating a DITA Style Guide A recommendation for any tech docs group that uses DITA extensively:  Helps new writers/contributors come up to speed  Usefully narrows the scope of the XSL work that needs to be done  Many things are “legal” in DITA but may be poor from a “house style” standpoint, for example: – Can have unformatted block content between a header and a table in a section – Tables and figures do not have to have a title – Can have unlimited nested lists – Alpha lists can contain more than 26 items – Lists can contain only a single item 18
  • 19. Schematron Can Help Enforce DITA Style What is Schematron? “Schematron is a rule-based validation language for making assertions about the presence or absence of patterns in XML trees.” (www.wikipedia.org) We use Schematron to point out to the writers potential errors/lapses in our DITA House Style:  Text between a section and table not wrapped in block tags:  A list ought to have more than one item (otherwise, why make it a list?): 19
  • 20. XSL Can Help Enforce DITA House Style We have a DITA house style that says nested lists should be no more than two levels deep.  Here’s Schematron doing it’s job:  And here is the result if you try to output it: 20
  • 21. Conrefs vs. Cloning At a very early stage we decided not to use conrefs in our DITA content • Made localization programmatically complicated/inefficient • Creating a localization kit would mean finding all conrefs in a doc (however many levels they are nested) and then “flattening” them; leads to inefficient segment-matching • Did not seem cost-effective from an author’s perspective • Would seem to limit reuse as conref targets become “fixed”; dare not change without affecting many docs • Searching and then defining a single phrase or paragraph to reuse not always an efficient use of time 21
  • 22. Conrefs vs. Cloning • We instead chose a “clone” approach to topic re-use: • Essentially, make a copy of an existing topic and use only the parts that you need in your current document • Original topic and cloned are completely separate (though trackable; parent/child relationship is retained in CMS) • Cloning is only done when the amount of change is sufficient that the original topic cannot accommodate it • Writers can more freely re-use existing topics for their own needs • When a localization kit is made, the segment matching process is efficient 22
  • 23. Nimble Localization Processes with DITA XML Under the old toolchain, localizing a 200+ page document to a single language within a week (without huge expense) was impossible. DITA XML allows us to be more nimble: for critical large documents, we can send the localization firm finished “parts” as we get them (“70/20/10”):  When roughly 70% of a large document is done, we send it off for translation, followed a week or two later with another 20% of new and updated material, then the last 10% when we complete it.  While this process does cost more than sending in a whole document at once, it reduces the turnaround time from weeks to days, and quality is much improved because it is not done in a rush.  This approach was simply not feasible using our old toolchain; ultimately, the new toolchain is still cheaper and much faster. 23
  • 24. Measuring Productivity: Uses of Metadata There are three main purposes for metadata:  Retrieval  Re-use  Tracking • Everyone who has used a search engine is familiar with the “Retrieval” part. • Authors can add their own metadata to topics to aid in later retrieval for re-use.  Topic and map dependencies can be checked, and associated topics re-used in other publications.
  • 25. Tracking Metadata Tracking metadata (in our case, mainly dates, author, and topic/map status) is used for understanding trends and managing workflow. The types of questions we can readily answer include:  Who created the content (author)?  When was it created (date)?  Who modified it (editor)?  Who reviewed it (reviewer/approver)?  Where has it been re-used (map relation)?  Has it been published or translated (status/language)? 25
  • 26. How We Measure Productivity Metric we use is a combination of topics created + topics modified in a monthly/quarterly timeframe:  Each new topic created counts as 1.  Modified topics are also counted, though again only as 1.  Subsequent revisions to the same topic in a given timeframe are not counted. Provides us with a very good view of ongoing work, and the numbers align with known product release cycles. Works both as an aggregate measure (total output per month), and as a measure of a writer’s individual productivity.  Maps are also tracked, but are not as good for measuring productivity since they come in many sizes and have widely varying development timelines. 26
  • 28. Topic Production Matches Product Cadence Product Product Product Release Cycle Release Cycle Release Cycle #3 #1 #2 Secondary Peak Secondary Peak Secondary Peak Main Peak Main Peak Main Peak • Regular peak of production in Q3, typically followed by secondary peak in Q1 28
  • 29. Localization Segments Auto-translated within CMS Monthly • Portion in orange is the percentage that were 100% matches, and were never sent to a localization vendor = pure ROI! • From July 2008 to July 2009, an avg. of 54% of segments were auto-translated within the system. 29
  • 30. Sample Topic Reuse Rate (Monthly) From Jan 2008 to June 2009, average monthly topic reuse rate = 53.53% 30
  • 31. An Interesting Trend: Topic Ratios Except in year one, reference topics steadily make up ~74% of all topics used 31
  • 32. What is the Average Size of a Topic? Maps avg. = 3.47 kb Concepts avg. = 2.46 kb References avg. = 7.88 kb Tasks avg. = 3.20 kb 1 byte = 1 character 1000 bytes (1 kb) = 1000 characters • Concepts avg. 0.65 of a page of Lorem ipsum text in Word • References avg. 2.6 pages  Smallest: half a page  Largest: ~200 pages • Tasks avg. 1 page 32