OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [dita] Understanding DITA vs. DITA OT


Tom,

Awesome example with the diagrams/narrative.
Computational Thinking is a term that has been going around in Computer Science education, and that's what I use for my examples as a teach DITA authoring here at Virginia Tech. J. Wing (currently at Microsoft) defines Computational Thinking as "the thought processes involved in formulating problems and their solutions so that the solutions are represented in a form that can be effectively carried out by an information-processing agent." She says that the main stages in Computational Thinking are abstraction and automation: you think about the abstractions (algorithms, big-picture ideas) related to a problem, and then, only then you or someone else will automate that process and fix the situation.
In my research and teaching work, I see DITA the standard as the method for abstraction (you have to think about your conrefs, your maps, your keys, your topic types) and then the Toolkit or a fancier software app is the automation agent. My students are mostly English majors, so they focus on DITA the standard/abstraction, and then automation happens when they use a tool. We separate the standard from the toolkit with this.
Here's a little more about Computational Thinking: https://www.cs.cmu.edu/link/research-notebook-computational-thinking-what-and-why and I also have a paper about my approach to teaching DITA with/through it that was published last year in the IEEE Transactions on Professional Communication and I can share if you are interested. 

Best,

Carlos
--- 
Carlos Evia, Ph.D.
Director of Professional and Technical Writing
Associate Professor of Technical Communication
Department of English
Center for Human-Computer Interaction
Virginia Tech
Blacksburg, VA 24061-0112
(540)200-8201






On Jun 21, 2016, at 4:32 PM, Tom Magliery <tom.magliery@justsystems.com> wrote:

Regarding the challenge of helping people understand the distinction between "DITA" and "DITA OT", here are some thoughts stemming from training new (to structured authoring) authors, parts of which some people find a little alarming, but all of which I cling to nerdily and stubbornly nevertheless. It starts with separation of structure and formatting. I use this premise to motivate a pair of diagrams, simple enough that I think you can get them from these verbal descriptions:
 
1. For "traditional/DTP", there are two blobs in the diagram, one of which says "Authoring tool" and has an arrow pointing to the other, which says "Output". 
 
2. For "structured authoring" the "Authoring tool" blob yields a "Structured document", which sits next to another (originless) blob called "Style sheets". Both of these blobs feed into another one called "Publishing system", which in turn points to the final blob "Output".
 
The mantra I use with these two diagrams is "With structured authoring you are not creating output; you are creating input." E.g., you are not saying "This stuff should have a box around it and be positioned over that-a-way"; you are only saying "This stuff is a sidebar". Then the publishing system says "Oh yeah, I know what to do with that."
 
From there it is an easy step to discussing the following very real process, strongly similar to the code-test-debug cycle in programming:
 
1. Write some code (XML/content).
2. Generate output.
3. Examine the output for correctness.
4. Fix errors and go to step 2.
 
I talk of the giddy anticipation when you're about to generate output again, the disappointment when it's still broken, and of course that eventual rush when you finally do get it right.
 
The "fix errors" part is a burden potentially shared by both authors and style sheet developers, which does complicate matters. As far as the analogy goes, this can be handwaved a bit by the fact that we are teaching authors about their particular perspective on this ecosystem. But this also gives an opportunity to discuss the negotiations/compromises that sometimes must be made between markup design, markup usage, and style sheet development effort. (Similar negotiations may occur between product management and development in a programming shop, btw.)
 
I think you could possibly push this analogy further with comparisons between DITA and programming languages, but I have not needed them, or thought them out enough to be sure how well it would work.
 
While I admit that this analogy may be a little scary to folks who think programming is intimidating, I also think that it helps strengthen the basic premise of separation of structure from formatting that really is fundamental to understanding why DITA <> DITA OT. The cyclical process with "write code" and "generate output" in different stages reinforces that they are different parts of the system.
 
mag



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]