Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Difference between DITA and S1000D

+0
−0

I'm trying to understand the technical difference between DITA and S1000D.

Yes, I know, the common wisdom is that if you need documentation for helicopter or submarine, you should use S1000D, and if you need documentation for software, you should use DITA. While this is true, it is too shallow level of understanding.

With a lot of searching I found some articles about technical side of this difference, but still, it's completely unclear for me, probably because I never worked with DITA or S1000D before.

  • From Slideshare presentation (slide 24):

    DITA maps specify hierarchy and the relationships among the topics; they also provide the context in which keys are defined and resolved.

    S1000D Publication Modules contain references to data modules, other publication modules, or legacy data of a publication and its structure.

  • From one article, which in turn an excerpt from the book:

    This points to one of the key differences between DITA and S1000D, which is the granularity of the level of reuse. While S1000D encourages reuse at the data module level (roughly equivalent to a topic within DITA), it does not have mechanisms for intra-data module reuse.

    My note: The word "intra" applied to "data module", not "data".

  • From another article:

    Both S1000D and DITA use the same underlying concepts and aims ... (from here to the end of the article).

  • Also, in one another article it is clearly stated that DITA and S1000D are assuming completely different types of authoring. DITA is topic-based, while S1000D is module-based:

    There is one more major alternative to the book based and topic based DTD and that is to chop up the XML content in modules. In our meaning not that far from the topic based but it is really about linking it to the product structure.

    My note: Well, from what I read about there are different types of modules in S1000D. We have "data modules" which are something similar DITA's "topics" and we have "publishing modules" which are something similar to DITA's "maps". For this reason, it's not clear which one of them implied within "modular-based authoring" term. Authoring based on data modules or authoring based on publishing modules? Argh.

So, what is the techinical difference between DITA and S1000D? How DITA's topic-based approach differs from S1000D's module-based approach? Does it all mean that S1000D is not so flexible in content reuse as DITA (see second quote in my post), and how exactly this unflexibility looks, in comparison with DITA?

History
Why does this post require moderator attention?
You might want to add some details to your flag.
Why should this post be closed?

This post was sourced from https://writers.stackexchange.com/q/37928. It is licensed under CC BY-SA 3.0.

0 comment threads

2 answers

You are accessing this answer with a direct link, so it's being shown above all other answers regardless of its score. You can return to the normal view.

+0
−0

Yes, these sorts of comparisons between systems are very difficult, essentially because there is no independent definition of terms like topic and module outside of the particular systems that use them. In other words, both systems, as well as several other similar systems, use similar terms to describe their models and functions quite independent of each other. It is not like comparing two minivans from different manufacturers. There is no agreed definition of horsepower or steering wheel or door that you can use to compare them with. You basically have to get down to the nitty gritty implementation details and see how they differ.

In my forthcoming book, Structured Writing: Rhetoric and Process, I try to provide some tool-neutral terminology for talking about structured writing methods, largely by avoiding these confusing terms altogether. When it comes to terms like module and topic, I suggest four types of information block: the semantic block (objects that writers would recognize independent of a structured writing system, like lists and tables), the structural block (the things semantic blocks are made from), the information typing block (the kind of blocks found in information typing theory, such as Information Mapping), and the rhetorical block (the thing that is actually meant to be read).

But even with those terms, I could not tell you which of these things a DITA topic is, because the term is just not well defined. Depending on how you use it, it could be any one of my four types. I don't know S1000D well enough to say how their idea of a module would fit, but I suspect it would be similarly vague.

Content, fundamentally, has fuzzy boundaries. It is all the stuff that does not fit neatly into data structures. Structured writing tries to make content look enough like a data structure to be processable by algorithms, but if you try to do that in a general way, you end up making your containers pretty fuzzy in order to fit around all the varied things they have to contain. And thus those containers tend to defy both characterization and comparison.

If you actually want containers that can be defined and compared with any degree of strictness, you have to be much more specific to the subject matter, audience, and type of document you are dealing with.

History
Why does this post require moderator attention?
You might want to add some details to your flag.

0 comment threads

+1
−0

Few short publications, that summarize the differences, and guide to a decision:

1) S1000D or DITA – Which Should You Use? ...A dude with 30+ years in the business of aerospace and software development provides the same "common wisdom" that you mentioned, and emphasizes the different philosophy of DITA "flexibility" vs S1000D "standard" (the "Theory X and Theory Y" part). ..."S1000D implementers dream of the flexibility of DITA, but understand why they’re locked into the S1000D “standard”."

2) DITA vs S1000D - Which One Is Right For Me? ...Specifications, including the differences, benefits and disadvantages to working with each. From an aerospace-industry oriented source.

3) DITA and software development: Ten reasons why DITA and Agile are made for each other and a match for software development teams: Starts from "Topic-based approach" (DITA topic), "Task topic type" (DITA General task topic), and more.

4) Another publication states "What sets DITA apart" (from S1000D). ...is "its specializations" and "inherited versatility". ...Example: IBM developerWorks: Specializing topic types in DITA: Creating new topic-based document types.

In addition:

  • Adobe FrameMaker can be used to handle DITA projects.
  • Adobe FrameMaker comes ready for DITA out of the box.
  • Adobe promotes DITA (Google it: Adobe DITA World)

--

I emailed Keith Schengili-Roberts from IXIASOFT (of publication number 3) about the technical-differences and his answer was a chapter from his book, that you already mentioned. I repeat:

"S1000D does include a mechanism for the reuse of content, known as data modules. These data modules can contain text and/or graphic content, and can be ‘plugged in’ where needed within any S1000D document. There are a number of data module types, roughly analogous to the DITA topic types, and include information that is specific for creating checklists, service bulletins, front matter, parts data, wiring data, learning modules, procedures, faults, information for the crew/operator and more. As you can see from this short list, many of the data modules were originally tailored for specific purposes within the aerospace sector which would not apply in more general circumstances." ... "The specificity of some of its module types to the aerospace and related industries limits the appeal for its adoption outside of these sectors."

(In S1000D) "Each data module comes with a unique identifier, called the Data Module Code, which is designed in part as a mechanism for ensuring that the same module do not appear more than once within a single document. This points to one of the key differences between DITA and S1000D, which is the granularity of the level of reuse. While S1000D encourages reuse at the data module level (roughly equivalent to a topic within DITA), it does not have mechanisms for intra-data module reuse."

(In DITA) "One of the chief differentiators of DITA when compared to the other documentation standards available is the ability to reuse content at both granular (i.e. word, phrase, sentence, topic) and topic/chapter levels. From a practical perspective, it is these multiple stages of reuse that come into play into making DITA a popular standard, making possible the additional advantages of consistent messaging, lower localization costs, and greater efficiencies as writers reuse existing content instead of having to recreate it."

History
Why does this post require moderator attention?
You might want to add some details to your flag.

This post was sourced from https://writers.stackexchange.com/a/38268. It is licensed under CC BY-SA 3.0.

0 comment threads

Sign up to answer this question »