Not applicable.
Kristen James Eberlein (kris@eberleinconsulting.com), Eberlein Consulting LLC
This document is part of a work product that also includes:
DITA 1.3 is distributed in three editions to better serve the needs of specific user communities. The specific user communities are those that are interested in:
This committee note explains the rationale for the three editions; it also provides an overview of what each edition contains, the intended audience of each edition, and metrics about each edition.
This document was last revised or approved by the OASIS Darwin Information Typing Architecture (DITA) TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document.
TC members should send comments on this document to the TC’s email list. Others should send comments to the TC’s public comment list, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/comments/index.php?wg_abbrev=dita.
When referencing this note, the following citation format should be used:
Copyright © OASIS Open 2015. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
For DITA 1.3, the OASIS DITA Technical Committee decided to issue the specification in three editions: Base, technical content, and all-inclusive.
This committee note explains the rationale for the three editions; it also provides an overview of what each edition contains, the intended audience of each edition, and metrics about each edition.
This section provides information about terminology and how it is used in this committee note.
The distribution of DITA 1.3 in three editions also reflects several interconnected factors, including new audiences for DITA, a new focus on topic and map as the core document types, and the growth of DITA over the decade that it has been an OASIS standard. The three-edition distribution also heralds changes to come in the future.
DITA has spread well beyond its origins in technical communication.
DITA is now in use in the following fields, among others:
The DITA Technical Committee wants to emphasize that topic and map are the base document types in the architecture.
Because DITA was originally developed within IBM as a solution for technical documentation, early information about DITA stressed the importance of the concept, task, and reference topics.
Many regarded the topic document type as nothing more than a specialization base for concept, task, and reference.
While this perspective might still be valid for technical content, times have changed. DITA now is used in many other contexts, and people developing content for these other contexts need new specializations. For example, nurses who develop evidence-based care sheets might need a topic specialization that has sections for evidence, impact on current practices, and bibliographic references.
The structure of the three editions makes it very clear that topic and map are the base document types, and that the other document types are specializations designed for specific user communities – currently technical content and learning and training.
Since its first release in 2005, each subsequent release of DITA has included new document and element types.
Metric | DITA 1.0 | DITA 1.1 | DITA 1.2 |
---|---|---|---|
Number of document types | 6 | 9 | 23 |
Number of element types | 193 | 299 | 535 |
Number of pages of PDF version of the specification | 292 | 593 | 1,236 |
The growth was natural and organic, as DITA evolved to better meet the needs of its users. DITA 1.1 introduced DITAVAL (a standard mechanism for defining a conditional-processing profile) and the book map (a specialized map for producing book-oriented publications). DITA 1.2 introduced even more document and element types, including the learning and training specializations, new variants of the task topic, glossary specializations, and taxonomic specializations. Between DITA 1.0 and 1.2, the number of elements more than doubled.
This increase in the number of elements scared some users, despite the fact that most users never used (or even saw) the majority of the new elements. As a result, the DITA Technical Committee planned to release DITA 1.3 in three editions, each optimized for specific users. This improves the chances of users getting only the pieces of DITA that they need—no more, no less.
The following table provides basic metrics about the sizes of the three editions.
Metric | Base edition | Technical content edition | All-inclusive edition |
---|---|---|---|
Number of document types | 4 | 17 | 26 |
Number of element types | 189 | 440 | 621 |
Number of pages of PDF version of the specification | 455 | 867 | 1,199 |
The subsequent chapters in this committee note provide information about each edition – what it contains and the intended audience – that is designed to help readers determine which edition best fits their needs.
Finally, note that even though DITA 1.3 includes new document and element types, the number of pages in the PDF version of the specification has decreased slightly. This is due to improvements in the information design. In addition, the DITA 1.3 specification has been made more usable by the addition of more examples and code samples that illustrate DITA features and mechanisms.
The three editions of DITA 1.3 set the stage for future developments: Lightweight DITA and DITA 2.0.
In July 2014, the OASIS DITA Technical Committee formed the Lightweight DITA subcommittee, chaired by Michael Priestley of IBM.
The goal of the Lightweight DITA effort is to develop a specification for a lightweight architecture that will ease implementation by vendors and adoption by users. The architecture will provide:
While work on DITA 2.0 is in the very early stages, there is general consensus among the DITA Technical Committee on the following points:
The base edition is the smallest edition of the DITA 1.3 specification.
The base edition contains the following document types:
The base edition is designed for application developers and people who need only the most fundamental pieces of the DITA framework.
Such users might include:
Users who create technical content should consider the technical content edition. Users who create learning and training materials should consider the all-inclusive edition.
This edition can be used for out-of-the-box authoring; it also can be used to develop specializations for fields other than technical content or learning and training.
Examples of such specializations might include the following:
You can consider several metrics concerning the size of the base edition.
Number of document types | 4 |
---|---|
Number of element types | 189 |
Number of pages of PDF version of the specification | 455:
|
The technical content edition is the medium-sized edition of the DITA 1.3 specification. It includes the base architecture and the specializations that are usually used for technical content.
The technical content edition contains the following document types, in addition to those from the base edition.
The technical content edition includes these technical-content topic types:
The technical content edition includes these technical-content map types:
The technical content edition is designed for authors who document complex applications and devices, such as software, hardware, medical devices, machinery, and more.
Such users might include:
This edition can be used for out-of-the-box authoring; it also can be used by DITA practitioners to develop specializations for industries such as software, hardware, manufacturing, and publishing.
Examples of such content and specializations might include the following:
You can consider several metrics concerning the size of the technical content edition.
Number of document types | 17:
|
---|---|
Number of element types | 440:
|
Number of pages of PDF version of the specification | 867:
|
The all-inclusive edition of the DITA specification is the largest edition. It is designed for implementers who want all OASIS-defined specializations, as well as users who develop learning and training materials.
The all-inclusive edition contains the learning and training document types, in addition to those from the technical content edition.
The all-inclusive edition includes these learning and training topic types:
The all-inclusive edition includes these learning and training maps:
The all-inclusive edition also includes specialized DITA metadata that can be used to specify characteristics of the learning content. This learning metadata is modeled on industry standards; it is available for use in both the learning topics and learning maps.
The all-inclusive edition is designed for authors and publishers who develop and deliver well-structured, modular instructional materials. It provides a framework for using a learning objects approach to organize and sequence content as a learning deliverable.
Users of the all-inclusive edition might include:
This all-inclusive edition can be used to author and deliver instructional materials that are used in K-12 education, corporate training, textbook publishing, online courses, educational testing, and more.
Examples of such content and specializations might include the following items:
You can consider different metrics concerning the size of the all-inclusive edition.
Number of document types | 26:
|
---|---|
Number of element types | 621:
|
Number of pages of PDF version of the specification | 1,199:
|
The following individuals participated in the creation of this document and are gratefully acknowledged.
The following table contains information about revisions to this document.
Revision | Date | Editor | Description of changes |
---|---|---|---|
01 | 23 August 2015 | Kristen James Eberlein | Created stub files for working draft. |
02 | 6 October 2015 | Kristen James Eberlein | Generated working draft 01. |
03 | 8, 17, 18, and 20 October 2015 | Kristen James Eberlein | Changes made to resolve DITAweb comments. Generated working draft 02. |
04 | 21-28 October 2015 | Kristen James Eberlein | Changes made to resolve DITAweb comments. Generated working draft 03. |
05 | 29 October 2015 | Kristen James Eberlein | Changes made to resolve review comments and standardize use of terminology. Generated working draft 04. |
06 | 3 November 2015 | Kristen James Eberlein | Generated working draft 05. |
07 | 12 November 2015 | Kristen James Eberlein | Generated working draft 06. |
08 | 05 January 2016 | Kristen James Eberlein | Generated committee note 01 for posting on OASIS Web site. |