doc book vs dita teresa

15
DocBook versus DITA: Will the real standard please stand up? Author: Teresa Mulvihill www.t2acommunications.co m

Upload: day

Post on 06-May-2015

4.012 views

Category:

Technology


19 download

TRANSCRIPT

Page 1: Doc Book Vs Dita Teresa

DocBook versus DITA:

Will the real standard please stand up?

Author: Teresa Mulvihill

www.t2acommunications.com

Page 2: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 2

About Teresa Mulvihill

Bachelor of Science in International

Communications and Technology

Working experience…

• In Europe • In North America• In Asia & South Pacific

Page 3: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 3

DocBook Vs DITA – Table of Contents

Background

Definitions

Concepts

Comparisons

Compatibility

Future possibilities

Make your own decision

Page 4: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 4

DocBook Vs DITA – Background

1991 1999

HaL Computer Systems

1998 2004

Page 5: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 5

DocBook Vs DITA – Definitions

DocBook is a document type definition (DTD) for writing technical books and articles, with the structure that such forms imply.

DITA (Darwin Information Typing Architecture) is both a DTD and a set of rules for writing online contextual documentation such as software help files.

Page 6: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 6

DocBook Vs DITA – Concepts

DocBook is hierarchical by nature, and must be developed to allow for single-sourced content.

DITA separatescontent from context, allowing multiple architectures of information.

DocBook is a fixed element and attributeset.

DITA is extensible, allowing the definition of information types.

Page 7: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 7

DocBook Vs DITA – Comparisons

Page 8: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 8

DocBook Vs DITA – Comparisons

Book (section) oriented

Context Topic oriented

Large set of elements and

attributes targeted for

technical documentation

Key Features Topic based

Separation of content and

context

Specialization

Page 9: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 9

DocBook Vs DITA – Comparisons

bat, bin, dtd, etc. files and

eDE able to run with as is

Download and Installation

bat, bin, dtd, etc. files, and transformation

engine

Regular XML file called an

include file with all files included in the document

Document file ditamap file with all files and each file’s

related links

Page 10: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 10

DocBook Vs DITA – Comparisons

PDF

HTML

HTMLHelp

Output Unrestricted, but all need development

Well supported by the XML community

Community Small, growing community

Page 11: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 11

DocBook Vs DITA – Comparisons

With a little development, DocBook can

do what DITA is attempting on a smaller scale.

Complexity DITA is impressively

engineered, but can be too industrial-strength.

Content Management

System

Possible needs Publishing plug-ins

Page 12: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 12

DocBook Vs DITA – Compatibility

• Similar structures• Easy(ish) mapping• Online communities and companies are already attempting to facilitate compatibility

•Oasis Open Document•Flatiron Solutions

Page 13: Doc Book Vs Dita Teresa

t2a Communications - LiveTechDocsSlide 13

DocBook Vs DITA – Future possibilities

The only constant is change…

XMLMind, XMLSpy, ArborText,

FrameMaker

Software XMLMind, ArborText, FrameMaker

Possible with development

WIKIs Community is working on a plug-in

Book hierarchy enables easier collaboration

Collaboration management

Possible with training for reviewers

Page 14: Doc Book Vs Dita Teresa

Slide 14

DocBook Vs DITA – Make your own decision

t2a Communications - LiveTechDocs

Documentation volume

Small to medium Large

Documentation output PDF, HTML, HTMLHelp

Various

Documentation input XML, MS Word, FrameMaker

XML, FrameMaker

Integration time frame Immediate One month plus

Budget Small to medium Medium to large

Page 15: Doc Book Vs Dita Teresa

Slide 15

Thank you!

Time for Q&A…

DocBook Vs DITA – The End

t2a Communications - LiveTechDocs