1 industry-centered business strategies presented by joann hackos, bob beims, chip gettinger, and...
TRANSCRIPT
1
www.oasis-open.org
Industry-Centered Business Strategies
Presented by JoAnn Hackos, Bob Beims, Chip Gettinger, and Scott Hudson
2
www.oasis-open.org
Understanding DITA: Its Impact On A Global Business Strategy
JoAnn T Hackos, PhDPresidentComtech Services Inc.
3
www.oasis-open.org
What is DITA?Pronounced Dit-Uh Darwin: DITA uses the principles of
inheritance for specialization Information Typing: DITA is designed
for topic-based technical information based on an information architecture of concept, task, and reference
Architecture: DITA provides the framework for the development of an Information Model
4
www.oasis-open.org
DITA at OASIS OASIS DITA Technical Committee at OASIS DITA architecture (including base topic types
defined in DTD and schema) contributed to OASIS in 2004
DITA 1.0 specification formally published by OASIS in 2005
DITA 1.1 specification now under review DITA public toolkit available through open
source (SourceForge) Domain specific communities beginning to
emerge in semiconductor, telecomm, aerospace, and more
5
www.oasis-open.org
Technical author maintains brand integrity
By selecting the best DITA type, I
can ensure consistency of content and
language and enhance our information
branding across information
libraries.
6
www.oasis-open.org
What is DITA exactly? DITA is an architecture for creating topic-
oriented, information-typed content that can be reused and single-sourced in a variety of ways
It is also an architecture for creating new topic types and describing new information domains based on existing types and domains
DITA is not just another tool but an international standard to support structured authoring and reuse in any technical domain
7
www.oasis-open.org
Core design principles of DITA Topic orientation
Discrete units of information covering a specific subject with a specific intent
Topic granularity Self-contained topics combine with other topics into
information sets Strong typing
DTDs and schemas guarantee that DITA types follow identical information structures
Specialization Architecture for extending basic types to new types adapted
for a particular use within an information set Common base class
Top-level "generic" base type provides “fallback” for all types
8
www.oasis-open.org
What are the business opportunities? Enhanced standards at the source More opportunities for standardized, consistent content More consistent branding of content Customized, branded look-and-feel for OEMs and
VARs More reliable use of translation memory Better schedules, less chaos at the end Reduced time and cost of production in multiple
languages Automated topic interrelationships to eliminate hand-
coding of references and links More languages and greater customization for global
audiences
9
www.oasis-open.org
The DITA Model
Standard, tested DTD A set of hierarchical DTDs (or schemas) Three basic information types based on a
generic topic type A set of elements
Information type specific elements Generic elements Map/Book specific elements Domain specific elements
10
www.oasis-open.org
Core DITA topic types
Provides background information that users
need to know.
Provides quick access to facts.
Provides procedural details such as step-by-
step instructions.
A unit of information which is meaningful
when it stands alone.
concept
topic
task reference
Core topic types specialized from “topic”
11
www.oasis-open.org
The DITA Model
The DITA Maps to assemble topics for output
Relationship tables so that we can relate topics to one another
Standard metadata attributes and values to select and filter content
12
www.oasis-open.org
The DITA Model
Specialization capabilities that allow us to create new information types and domain-specific elements to meet unique organizational and industry needs
Processes that automate the production of deliverables in PDF, HTML, Help, Eclipse and others
13
www.oasis-open.org
DITA domains
A DITA domain defines a set of elements associated with a particular subject area or authoring requirement regardless of topic type
Current implemented domains Programming languages Software User interfaces
19
www.oasis-open.org
DITA Open Toolkit
Contents or purpose
xsl
temp
schema
samples
resource
out
lib
dtd
doc
demo
css
ant
– Intermediate files (created during processing)
– Formatted output (created during processing)
– XSLT files for XHTML and PDF processing
– XML Schema definitions for the DITA vocabulary
– Example DITA content for exercising the processing
– Styles and other resources for XHTML and other output
– Java implementation of advanced processing
– Document type definitions for the DITA vocabulary
– Documentation for DITA or the Open Toolkit
– Experiments or demonstrations of DITA capabilities
– Styles for displaying XML source files in editors or browsers
– Templates for defining what to build
DITA-OT
20
www.oasis-open.org
DITA processing
.DTD.schema
.ditamap .XSLT
.CSS
Output File
(.html)
Document Type Definition – gives structure and validation to your XML source file
DITA source file - where you author your content pieces
Stylesheets - are applied to the XML file to produce a formatted output
HTML file - is one of the outputs produced from the XML source file (You can also produce PDF, HTML Help, and more)
.ditaval
.ditaval file – specifies what information to include or exclude from your final output using attribute values
.dita
DITA map - specifies the order of the DITA source files for your final output
21
www.oasis-open.org
DITA Specialization to Streamline Data Interchange
The Business Case for a Semiconductor-industry DITA Specialization Effort
Bob Beims, Application EngineerFreescale Semiconductor, Inc.
22
www.oasis-open.org
Outline Are Industry Standards In Place? Are Problems Solved by Exchange? Do the Data Models Match Up? How Will DITA Specializations Help? How Will We Do It?
23
www.oasis-open.org
Semiconductor Data Domains Served by XML Standards
IP Logical Design•SPIRIT Consortium(IP-XACT, IEEE P1685)•Machine readable•Register descriptions•Signal descriptions
Product Physical Design
•RosettaNet.org(RNTD, IEC6-1360)•Machine readable•Product classifications•Characteristic properties
Customer Information Design
•OASIS(DITA)•Human readable•Functional descriptions•Data collected from other domains
24
www.oasis-open.org
Outline Are Industry Standards In Place? Are Problems Solved by Exchange? Do the Data Models Match Up? How Will DITA Specializations Help? How Will We Do It?
25
www.oasis-open.org
Non-aligned Sequential Flows Sequential, open-loop,
disjointed processes and tool chains
Fragile linkage, opportunities for error throughout
Stagnant Desktop publishing practices:
No time for customer needs analysis or filling in the gaps
Book-level reuse is extremely difficult, forces write/copy many, use each asset only once
The critical activity of creating content is squeezed in at the end
Significant non-value-add effort wasted on format conversion and asset tracking
Result: Massively redundant efforts cause errors, missed deadlines and frustrated customers
Lack
of c
omm
on
lang
uage
pre
vent
s
auto
mat
ed s
hari
ng
of in
form
atio
n
IP Design
Verification
SoC Integration
Manufacture
DevTool Development
Docum
entation
Web P
resence
Gather Req’ments
Training D
ev
26
www.oasis-open.org
XML-aligned Concurrent Flows Parallel, closed-loop,
optimized processes and tool chains
End-to-end linkage, requirements through delivery
Leverages Information Development best practices:
Give customers what they need, not simply what we have
Proven topic-based reuse methodology enables write once, use everywhere
Critical activity of content creation is done throughout
Format conversion and asset tracking is automated through infrastructure platform
Result: More time for value-added Information Development means on-time delivery, delighted customers
Sta
ndar
dsB
ridg
e th
eS
trea
ms
IP Design
Verification
SoC Integration
Manufacture
DevTool Development
Customer Information Development
Training Dev
Gather Req
Web Presence
IP-XACTRosettaNet
DITA
27
www.oasis-open.org
Merging The Data Streams
IP P
hys
ica
l D
esi
gn
IP In
for m
ati o
n
Dev
el o
pm
ent
Cu
s tom
er
Con
ten
t D
eliv
ery
IP L
ogic
Des
i gn
Memory Map,Signal Names
(IP-XACT)
Product Design Repository
Electrical Characteristics(IEC 61360 /
RNTD )
Manufacturing Data
Repository
Functional Descriptions(DITA , SVG,
MathML )
Information Assets
Repository
Information Deliverables(PDF, HTML )
Publication Engine
(ANT, FOP, SAXON )
XQUERYXSLT
XQUERYXSLT
XQUERYXSLT
Document Types and Layouts
(XSL, ditamap )
Scripts & Style Sheet
Repository
RelationshipLinks
28
www.oasis-open.org
Outline Are Industry Standards In Place? Are Problems Solved by Exchange? Do the Data Models Match Up? How Will DITA Specializations Help? How Will We Do It?
29
www.oasis-open.org
Example: IP-XACT memoryMaps
<?xml version="1.0" encoding="UTF-8"?><spirit:component
xmlns:spirit="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.0">
<spirit:vendor>Spirit</spirit:vendor> <spirit:library>Leon2</spirit:library> <spirit:name>uart</spirit:name> <spirit:version>1.0</spirit:version> <spirit:memoryMaps> <spirit:memoryMap> <spirit:name>ambaAPB</spirit:name> <spirit:addressBlock> <spirit:baseAddress>0</spirit:baseAddress> <spirit:bitOffset spirit:format="long">0</spirit:bitOffset> <spirit:range spirit:format="long">16</spirit:range> <spirit:width spirit:format="long" spirit:id="width">6</spirit:width> <spirit:register> <spirit:name>data</spirit:name> <spirit:addressOffset>0x0</spirit:addressOffset> <spirit:size>32</spirit:size> <spirit:access>read-write</spirit:access> <spirit:description>Data read/write register</spirit:description> </spirit:register> </spirit:addressBlock> </spirit:memoryMap> </spirit:memoryMaps></spirit:component>
30
www.oasis-open.org
Example: DITA memoryMaps 1 How difficult is it to capture SoC information via the standard DITA model? Screenshot below shows out-of-the-box use of a DITA-aware editor to capture
information in a DITA table. Following slide shows the XML output.
31
www.oasis-open.org
Example: DITA memoryMaps 2<?xml version='1.0' encoding='UTF-8'?><!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"><reference id="RegMapRefXmpl"> <title>Register Map Reference Topic Example</title> <shortdesc>This is an example of capturing register information in a standard DITA reference topic.</shortdesc> <refbody> <table> <title>Register Map Title</title> <desc>Register map table description</desc> <tgroup cols="7"> <colspec colname="regName"/> <colspec colname="regOffset"/> <colspec colname="regSize"/> <colspec colname="regAccess"/> <colspec colname="regReset"/> <colspec colname="regDesc"/> <colspec colname="regDimens"/> <thead> <row> <entry>Register Name</entry> <entry>Offset</entry> <entry>Size</entry> <entry>Access</entry> <entry>Reset</entry> <entry>Description</entry> <entry>Dimension</entry> </row> </thead> <tbody> <row> <entry>data</entry> <entry>0x0</entry> <entry>32</entry> <entry>read-write</entry> <entry>0x0</entry> <entry>Data read/write register</entry> <entry/> </row>
SoC information captured using standard DITA table elements, using colspec attribute for semantic information needed by XSLT processing.
Additional prolog metadata could be added to capture product, platform, audience, revision and otherprops, as needed.
The OASIS CALS table model used in DITA allows use of attributes in entry elements for added semantic tagging.
For information that can be represented in tabular format, specialization may not be needed.
32
www.oasis-open.org
.ditamap, .dita and .ditaval files
preprocess topic mergetransform to
XSL-FOtransform to
PDFPDF output
SPIRIT and IEC .xml files
transform to DITA
.ditamap, .dita and .ditaval files
preprocess topic mergetransform to
XSL-FOtransform to
PDFPDF output
SPIRIT and IEC .xml files
data element extraction
spirit2fo/iec2fo transforms
DITA Processing Pipeline Integration Options
Import option: Pre-process IP-XACT and/or RNTD data to DITA:
Pro No OT mods needed, preview in DITA editor
Con IP-XACT/RNTD transform breaks direct linkage of elements
Link option: Transform IP-XACT and/or RNTD data within pipeline:
Pro Direct, real-time links to latest IP XACT/ RNTD assets
Con No preview in DITA editor, OT plug-in development needed
33
www.oasis-open.org
Outline Are Industry Standards In Place? Are Problems Solved by Exchange? Do the Data Models Match Up? How Will DITA Specializations Help? How Will We Do It?
34
www.oasis-open.org
How Will Specializations Help? Guide authors toward more consistent content
creation Enable round-trip exchange with other XML
vocabularies Symantec information typing for output processing Potential semiconductor-specific information types:
Instruction Set Architecture reference Memory Map / Register / Bit Field reference Signal Characteristics reference Electrical Characteristics reference Mechanical Specifications reference
35
www.oasis-open.org
Finding the Specialization Fit
Legacy Document Analysis Identify often-repeated patterns Are these patterns filled / created from common
data sources of other business processes? If so, is there an applicable open standard for the
data source(s)? If so … single source and merge the streams!
Specialization Targets Structures Element Types Element Attributes
36
www.oasis-open.org
Outline Are Industry Standards In Place? Are Problems Solved by Exchange? Do the Data Models Match Up? How Will DITA Specializations Help? How Will We Do It?
37
www.oasis-open.org
How Will We Do It?
Gap analysis: information type needs versus base DITA types
Select closest match base DITA elements / structures
Define deltas, create specialized content and processing modules
38
www.oasis-open.org
Do We Need To Do It?
DITA components / attributes vs. SoC customer information set deliverables
Are there SoC information types that get lost in ditabase?
Are there SoC vocabularies that can’t be expressed in ditabase?
Is DITA IP-XACT / RNTD round-trip impossible with ditabase? (Is it needed?)
Are specific semantic keys needed to generate the output customers have come to expect?
39
www.oasis-open.org
“The principles of document engineering seek to find a balance between technology
and business, between process and information, between bottom-up and top-
down thinking, and between concepts and implementation.
Successful document engineerswill do the same.”
Robert Glushko and Tim McGrathDocument Engineering
Document Engineering Defined
40
www.oasis-open.org
Adoption of DITA inMedical Devices
Chip GettingerVP, Services and Sales SupportAstoria [email protected]
41
www.oasis-open.org
DITA Adoption @ Siemens Medical Goals
Joint authoring based on a common topic centric model
Re-use processes between service and user doc Integration of different requirements across business
units Integration of supplier documentation
Preconditions Existing XML content after transform must be usable
with content and versioning information Authoring workflow: means “authoring as usual” Use existing Astoria CMS system landscape
42
www.oasis-open.org
XML/DITA based on OASIS standards with backing from global players.
Linguistic adaptability for all used terms.
Reduces costs for training and simplifies the integration of external information.
Simplifies exchange and use of technical information.
Local optimum can be reached without loss of global optimum.
Perfect exchange standard enabling easy integration of suppliers.
Allows publication “out-of-the-box” and customization using individual stylesheets.
DITA is not fixed on specific content, it contains a method for data modeling.
Advantages of DITA for Siemens
Flexible designability of info types combined comprehensible Astoria CMS history.
Use of common standards
Global content
System extensibility
Exchangeability
Traceability
Business Unit integration
OEM integration
Flexible publishing
...
43
www.oasis-open.org
Process Basics
PublishingPublishingAuthoringAuthoringModelingModeling
ContentStructure Layout
DTD Instance Document
researchauthoring
analyzingstructuringmodeling
selectingtransforming
publishing
44
www.oasis-open.org
Evolution within the last years ...
Innovation cycles dramatically shortened Dramatically increased volumes, e. g. content,
output media, languages, doc types, authors, products, ...
Documentation creation today concurrent with development
# of languages today = 23 Speeding up translation & localization cycles Focus on translation costs Global use of information according to Single
Source principle Integration of OEM documentation Increasing process requirements
With adoption of the Astoria CMS and DITA
45
www.oasis-open.org
Clear Structure from creation ….
…. to final layout
Structured input – output layout
46
www.oasis-open.org
Usage - How does the customer work ?
…Unique and Benchmark at Siemens
47
www.oasis-open.org
DTD Harmonization based on DITA Content
SieMed Fine structure Information classes Orgdata Publishing structure
Processes SieMed
Authoring Processing content Reuse Publishing
DITA
Domains Topic types Attributes Maps
topic writing/direct import DITA-based processing DITA-reuse with conref DITA-based publishing/direct
export
48
www.oasis-open.org
DITA Medical Devices Specializations Blocks of information can be deduced methodically over several
levels Enables development and use of specific DTDs based on a
common foundation
DITA.dtd
Medical.dtd
SiemensMed.dtd
GG.dtd CS.dtd Supplier_A.dtdHS.dtd
50
www.oasis-open.org
DITA topics, maps and
graphics are created,
versioned and stored in AstoriaAuthors reference topics and graphics into
product deliverables
(Maps)Product configs, audience, etc.
are managed as part of each
topic
Authors can search to
discover topics from other
authors
51
www.oasis-open.org
Topics are edited using the
Arbortext XML Editor via the
Astoria Bridge.
52
www.oasis-open.org
Using the DITA Open Toolkit, a Topic Map
is published and filtered to HTML
Help, PDF, Java Help, etc. that is filtered
for a specific customer.
53
www.oasis-open.org
Medical Devices DITA Subcommittee Defining goals and objectives Siemens Medical specializations to be
available in public domain Faster time for adoption Adoption of industry best practices Supplier content interchange and updates
54
www.oasis-open.org
Learning Content Specialization SC
Goal: Develop a general top-level design for structured, intent-based authoring of learning content with good learning architecture, following DITA principles and best practices.
Scott Hudson, Senior Consultant
55
www.oasis-open.org
Top-level approach and assumptions Adopt a top-level design for DITA
topic-based learning content that is equally informed by the Cisco/Clark learning objects approach and by leading instructional models, and complements the Sharable Content Object Reference Model (SCORM).
56
www.oasis-open.org
Working Assumptions A learning object consists of:
instructional objects, which provide the structured framework for a learning experience, and
information objects, which provide the source learning content.
DITA topic types provide the meaning and intention to content contained in instructional and information objects, and as such, comprise the basic building blocks for learning objects.
DITA maps arrange dita topic type files into a sequence as learning objects and organize such content for delivery as lessons, modules, and courses.
DITA specialization provides the mechanism for creating learning-based topic types needed for instructional and information object content requirements.
57
www.oasis-open.org
Instructional ObjectsInstructional objects are comprised of the following specialized DITA
topic types:
Instructional Design topic type Describes learning needs and goals, instructional design models, task analyses,
learning taxonomies, and other information necessary to the lesson planning process.
Learning Overview topic type Identifies the learning objectives, includes other information helpful to the learner,
such prerequisites, duration, intended audience, and can include information and strategies that seeks to gain attention and stimulate recall of prior learning.
Learning Summary topic type Recaps and provides context for the learning objectives, provides guidance to
reinforce learning and long-term memory, and may pose questions to enhance encoding and verification of the learning content.
Learning Assessment topic type Presents instruments that measure progress, encourage retrieval, and stimulate
reinforcement of the learning content, and can be presented before the content as a pre-assessment or as a post-assessment test. The interactions use a sub-set of the Question-Test Interoperability (QTI) specification, implemented as a DITA domain specialization.
58
www.oasis-open.org
Information ObjectsInformation objects are comprised of the following
specialized DITA topic types: Learning Content topic type
Provides the learning content itself, and enables direct use of content from DITA task, concept, and reference topics, as well as additional content of any topic type that supports specific objectives declared in the Learning Overview topic type. A Learning Content topic comprises a set of self-contained content about a single terminal learning objective supported by zero or more enabling learning objectives.
Learning Enhancement topic type Describes and presents content that supplements the
primary learning content, such as practices, exercises, or simulations, and could also include scenarios that invoke role playing, games, in-class homework, and group discussions.
59
www.oasis-open.org
Overview of Learning Objects
60
www.oasis-open.org
DITA Processing Model for Learning Content
61
www.oasis-open.org
S1000D-DITA Interoperability Forum
"One way to facilitate interoperability between S1000D and DITA is to use S1000D element names and semantics when creating DITA specializations for domains such as the machine industry.“
Should a full OASIS TC address the issue of Interoperability via a separate specification for Specialization?
Should a DITA SC be set up to create a specialization for mapping S1000D data module elements to DITA?
62
www.oasis-open.org
Resources online Download the DITA toolkit
http://sourceforge.net/projects/dita-ot/ Talk to others about DITA
Join the dialog on the DITA forum –http://groups.yahoo.com/group/dita-users/
Research more about DITA OASIS – http://www.oasis-open.org/committees/dita Cover pages – http://xml.coverpages.org/dita.html Knowledge base – http://dita.xml.org
Developer workshops Arbortext series http://www-128.ibm.com/developerworks/xml/library/x-dita1/inde
x.html http://www.arbortext.com/resources/
63
www.oasis-open.org
DITA Translation Subcommittee Advises the DITA Technical
Committee on issues critical to localization and translation
Proposes enhancements to the DITA architectural specification
Develops DITA best practices for authors, businesses, and localization service providers
64
www.oasis-open.org
Translation SC
Membership Organizations that require translation
and localization of technical content Industry consultants Localization services provides Localization technology developers
65
www.oasis-open.org
Contributions to date DITA architectural specification 1.1
Directionality attribute Translation attribute XML lang attribute clarification Translatable block and inline elements Indexing sort order XLIFF compatibility Liaison with the W3C ITS Working Group
Best Practices Indexing Translation memory Multi-language documents Content references (conrefs)