DITA Darwin Information Typing Architecture

What is DITA?

What is DITA DITA is an XML-based end-to-end architecture for authoring, producing, and delivering technical information. (Wikipedia) DITA is an XML-based end-to-end architecture for authoring, producing, and delivering technical information. (Wikipedia)

One Slide History Originally developed by IBM in 2000 by a cross-company work group after an effort to organize all their technical documentation into a single source. Originally developed by IBM in 2000 by a cross-company work group after an effort to organize all their technical documentation into a single source. March 2004, IBM donated DITA to the Organization for the Advancement of Structured Information Systems (OASIS). March 2004, IBM donated DITA to the Organization for the Advancement of Structured Information Systems (OASIS). May 3rd, DITA version 1.0 approved as an OASIS Standard May 3rd, DITA version 1.0 approved as an OASIS Standard OASIS continues to update DITA and are currently on version 1.1 OASIS continues to update DITA and are currently on version 1.1

How Does It Work?

How It Works DITA divides content into small, self- contained topics that can be reused in different deliverables. DITA divides content into small, self- contained topics that can be reused in different deliverables. The core of DITA consists of a topic DTD (Document Type Definition, an XML scheme langauge a.k.a XML “templates”— ) and a map DTD (topic) The core of DITA consists of a topic DTD (Document Type Definition, an XML scheme langauge a.k.a XML “templates”— ) and a map DTD (topic) Besides generic topic type, DITA specifies three basic topic types, Task, Concept and Reference. Besides generic topic type, DITA specifies three basic topic types, Task, Concept and Reference. These are then put into Topic maps. These are then put into Topic maps.

Topic Types?!

If You Get HTML and XML… Dancing Dancing is a very difficult art to master but fun to screw up.

The Three Basics Topic Types Task Topic Task Topic Concept Topic Concept Topic Reference Topic Reference Topic

Task Topic Describes how to accomplish a task. It lists a series of steps that users follow to produce a specified outcome. Describes how to accomplish a task. It lists a series of steps that users follow to produce a specified outcome. (EX: Move your leg)

Moving a leg If you want to dance you have to do this. Get your brain to tell the muscles in you leg to move Move your foot forward and set it down again. Task Topic Example

Concept Topic Information designed to be more objective, containing definitions, rules, and guidelines. Information designed to be more objective, containing definitions, rules, and guidelines. (EX: History of Dance)

Concept Topic Example: History of Dance People have been dancing since before recorded history. Some early cultures that have records of early dancing are: Greece Egypt

Reference Topic Describes command syntax, programming instructions, other reference material; it usually contains detailed, factual material. Describes command syntax, programming instructions, other reference material; it usually contains detailed, factual material. (EX: A Dip)

Reference Topic Example The Dip Dip Impressive/Basic A dip can be a basic but effective move for impressing a dance partner. It is executed by holding the partner firmly at between a 45 and 80 degree angle. If executed poorly it can result in injury.

Topic Map Relationship Tables and Map Lists

Map List Example

Relationship Table Example

Who Should Use DITA? ?

You Should Use DITA If: You have content online. You have content online. You exchange technical documentation with other groups that use DITA. You exchange technical documentation with other groups that use DITA. You have someone to enforce it You have someone to enforce it

Shouldn’t Use If: No one will use it. No one will use it. Your source is print based. Your source is print based.

Why Use It?

Advantages Topics can be easily reused in different deliverables. Topics can be easily reused in different deliverables. Fragments of content within topics (or less commonly, topics themselves), can be reused through the use of content references. Fragments of content within topics (or less commonly, topics themselves), can be reused through the use of content references. Improves retrievability Improves retrievability

Questions