Buzzword at Work - An Agile Approach to Spezialized DITA-based Authoring

Download Buzzword at Work - An Agile Approach to Spezialized DITA-based Authoring

Post on 12-Jul-2015

284 views

Category:

Technology

5 download

Embed Size (px)

TRANSCRIPT

  • 2008-11-17

    Buzzwords at Work

    An Agile Approach to Specialized DITA-Based Authoring

    G. H. Krause, Senior Manager TechDoc

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 2 Copyright Qimonda AG 2008 All rights reserved.

    About Gunnar

    Senior Manager for Technical Documentation at Qimonda AG DITA is on his mind since 2005 and he actively promotes it for two years.

    R&D engineer prior to 2002 working within the areas of design, design-for-testability and product testing including located in the US and Germany.

    Always part of the job: knowledge transfer, training and project documentation

    Gunnar is involved with group dita-users at yahoo.com http://tech.groups.yahoo.com/group/dita-users/

    Gunnar is member of the content wrangler community http://thecontentwrangler.ning.com/

    You can network with Gunnar via plaxo.com http://ghkrause.myplaxo.com/

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 3 Copyright Qimonda AG 2008 All rights reserved.

    History

    DITA Europe 2007 Did DITA cross the chasm? DITA in the light of technology adoption life cycle.X-PUBS 2008 Chunking with confidenceDITA Europe 2008 Buzzword at work: An agile approach to specialized DITA-based authoring

    You will hear today The business case that opened the door to DITA Embrace DITA specialization Why agile project management does fit

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 4 Copyright Qimonda AG 2008 All rights reserved.

    Qimonda, a Top 5 Global DRAM Manufacturer*

    NYSE listed since August 9, 2006 13,500 employees globally** Major R&D operations in 6

    locations on three continents Manufacturing facilities in

    Europe, North America and Asia

    Broad and growing range of DRAM products for infrastructure, graphics, mobile and consumerapplications

    Standard DRAMs for use in PCsand workstations

    Our Global Footprint: FY 07 Revenues EUR 3.6bnOur Global Footprint: FY 07 Revenues EUR 3.6bn

    18%12%

    33%

    37%

    Europe

    North America

    Asia / Pacific

    Japan

    Our CompanyOur Company

    Our ProductsOur Products Strong Customer BaseStrong Customer Base

    *Source: Gartner, June 2008; **By end of calendar year 2007

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 5 Copyright Qimonda AG 2008 All rights reserved.

    Qimonda Sells DRAMs

    The product portfolio is diversified and homogeneous at the same time Different interface standards Varying target applications Scalable in memory density Short product replacement cycles driven by technology improvements

    There is more to share than styleguide and template Technical drawings Tables with technical parameters Feature lists Conceptual information

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 6 Copyright Qimonda AG 2008 All rights reserved.

    Qimonda TechDoc Some Numbers

    One central department with about ten people Information developers, authors, programmers, contractors, students

    Tasks About 1000 documents as PDF to be administrated in DMS 150 releases of technical documents per month Up to 100 review and approval cycles per month

    Deliverables are English only for engineers to build systems and applications PDF only for download, no hardcopies distributed

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 7 Copyright Qimonda AG 2008 All rights reserved.

    Motivation for Migration to Topics

    Smaller chunks allow Semantic topics (DITA, Information Mapping) Work in parallel instead of sequentially in a team setup Avoid duplication of work during Authoring (reuse),

    Review (less redundancy),

    Translation (more 100% matches), and

    Rendering personalized deliverables (repurpose)

    Workflow improvements

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 8 Copyright Qimonda AG 2008 All rights reserved.

    Motivation for Migration to TopicsWorkflow Improvements

    Request Submit

    Req. assigned to documents

    Check buildingblocks and correctfor each data sheet

    Parallel Review of N completeData Sheets

    Approve & Release

    Old Workflow

    DITA and CMS based Workflow

    Request Submit

    Automatic Document Generation

    Check buildingblocks and correct

    - keep reusable

    Block Review by expert(s)

    Approve & Release

    ReuseReady

    ??

    AutomaticDocumentGeneration

    Yes

    No

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 9 Copyright Qimonda AG 2008 All rights reserved.

    Motivation for Migration to TopicsWorkflow Change for Worse

    But Authoring, review and translation might be more difficult Loss of context

    Require standardization of terminology, grammar, style Readers stumble over inconsistencies

    You must search for exisiting topics prior to writing a new one Tidious search? Duplication instead of reuse?

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 10 Copyright Qimonda AG 2008 All rights reserved.

    Motivation for Migration to TopicsWorkflow Change for Worse

    And the problems take its toll You may need to use topics that others created and maintain Loss of control for authors

    More topics mean more workflows to run Increase of work for administration

    More metadata values or parameter needed to identify topics Increase risk of errors

    Change of mindset, change of attitude, changed behaviour A tool change is a change in culture!

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 11 Copyright Qimonda AG 2008 All rights reserved.

    Business Case for Qimonda TechDoc

    Saving Review workflow

    + Take the number of document-based reviews Multiply by average page count Multiply by average review time per page Multiply with number of reviewers selected on document level Subtract time needed by experts to review chunks

    Document rendition DTP tool blocks desktop for half an hour to 4 hours per PDF rendition

    Server based rendition supports batch rendition of document family

    Increased efficiency of experts & information developers

    /We do not translate ... seems to be easier to calculate!

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 12 Copyright Qimonda AG 2008 All rights reserved.

    My Blend of StrategiesGuideline for Chunking

    Comply with DITAs topic definition for task, concept, reference. Semantically correct topics.

    Restrict each topic to answer one question only. Increase reuse opportunities.

    One topic is to be reviewed by a single group of subject matter experts. Speed up review and approval cycle

    A topic belongs to a single product family or is of kind generic. Use generic topics for cross-family reuse

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 13 Copyright Qimonda AG 2008 All rights reserved.

    My Blend of StrategiesMap of Chunks

    Reuse Pools1-to-1

    Topic Pool with linked image(s) Image Poolrelation

    Footnote Pool

    Attention/Note Pool

    Pool of Rendition Settings

    DITA Topic Types

    Qimonda Topic Types

    Topics

    Sub maps(chapter)

    Maps (for a family of

    documents)

    conref (N-to-N relation)topicref (N-to-N relation)other N-to-N relationsother 1-to-N relations

    RenditionConfig

    w/ ditaval &variable

    def.

    DITA OTFM Server

    PDF

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 14 Copyright Qimonda AG 2008 All rights reserved.

    My Blend of StrategiesThe New Qimonda TechDoc Approach

    Old style Qimonda document New stylecover.fm

    chapter_01.fm

    chapter_02.fm

    chapter_03.fm

    ...chapter_08.fmTOC.fmimprint.fm

    Cover pageRevision History1 Chapter1.1 Section1.2 Section2 Chapter

    3 Chapter3.1 Section3.2 Section...8 ChapterTable of ContentsImprint

    (Template)(On the fly)concept_01.xmlconcept_01a.xmlreference_01b.xmlconcept_02.xmlreference_02a.xmlreference_02b.xmlconcept_03.xmlreference_03a.xmltask_03b.xml...reference_08.xml(On the fly)(Template)

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 15 Copyright Qimonda AG 2008 All rights reserved.

    Qimonda TechDoc Tool Set

    Structured FrameMaker 7.1 since 2004

    New DITA-based Single-Sourcing CMS XMetaL Author and XMAX for editing linked to MS Sharepoint as repository DITA Open Toolkit for publication with Adobe FrameMaker Server as PDF rendering engine

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 16 Copyright Qimonda AG 2008 All rights reserved.

    Why DITA Specialization?

    Qimonda has a docbook like homegrown DTD

    My experience Document structure is stable But improvements for semantical tagging are needed again and againChanging the Document Type Defintion (DTD) Needed urgently by pilot users Difficult to align across the company in a short time periodEffort and cost generated with each update Who pays for the migration in other projects? Who is responsible to test and update the XSLTs?

  • Qimonda G. H. Krause Senior Manager TechDoc 2008-11-17 Page 17 Copyright Qimonda AG 2008 All rights reserved.

    DITA Specialization

    From Architectural Specification of DITA 1.1:Chapter 5. DITA specialization

    Specialization is the process by which new designs are created based off existing designs, allowing new kinds of content to be processed using existing processing rules.

    My experience Solves the time and cost issue in our company Specialization gets