 |
|
| Blog
|
|
 |
|
(DITA) Conversion is futile
By Julio Vazquez posted on January 20, 2012 10:20
You're probably saying to yourself, Am I in the right blog? You are.
One of the things I see in this business are companies who hear
about DITA and the benefits of an XML-based publication system and
say, Yes, verily. Make it so! They believe that it's just a matter
of taking their current content and converting it to DITA and they're
done.
Nothing can be further from the truth.
When I talk about moving to DITA, I avoid the term conversion as if it were Snooki or a Kardashian. You really shouldn't convert your content to DITA, you should migrate or evolve to DITA. What does this mean?
You need to start with a content inventory.
- What's in there that's still good?
- What can be trashed? (You don't want to change stuff that's no good anymore, do you?)
- What content currently embodies the DITA architecture and philosophy?
- What DITA content models does a particular topic map to the most?
- What's duplicated and should be a single topic or pulled from an object library?
- Do topics need updating?
- Would they be better served with a rewrite?
Lots of questions to answer. This before a single <p> element wraps around any of the content (let alone a <topic> element).
So, for DITA, conversion is futile.
What else should you do before preparing to move to DITA?
About the Author
Julio Vazquez
Julio Vazquez is a Senior Information Architect at SDI with over 30 years of experience in technical communications and information technology. As one of the members of the initial DITA task force, he takes his share of blame for the current architecture and language structure. Julio holds a bachelor’s degree in computers and information systems from Empire State College of the State University of New York and has spoken at technical communication and STC conferences about DITA and information architecture and is the author of Practical DITA.
Recent Related Articles:
Is documentation the right word? -
4 : the usually printed instructions, comments, and information for
using a particular piece or system of computer software or hardware
(www.merri...
Upcoming webinar: Moving to XML -
On May 23, I will be presenting this topic in a JustSystems Webinar. For those who are just starting to move to XML (DITA/XML is just dandy) or consid...
Welcome to the 60s -
As I approach my birthday, I've decided to do something I rarely do. Look back at my career in technical communications to see what I've learned and m...
The burden of burdensome writing -
This isn't meant to be a political statement but there is something interesting going on in NC right now. I'm not going to take a position one way or ...
It's about conversation. Let's converse! -
The incredibly insightful Mark Baker wrote last week that it's time to change the "doctrine" of technical communication. You should read Mark's whole ...
Comments:
Larry Kunz
Friday, January 20, 2012 11:02 AM
That's true. But, alas, it's easier to sell a client on the idea of conversion than on a total fruit-basket-turn-over of their content. So we call it conversion and then explain that a conversion is much, much more than simply slapping XML tags on their content. Mark Baker had a good article on this a while ago: http://everypageispageone.com/2011/12/12/structured-writing-is-not-desktop-publishing-plus-angle-brackets/
Julio Vazquez
Friday, January 20, 2012 11:15 AM
Agree that it's easier to sell a client on conversion than an evolution, Larry. However, I think that it's best that we start with the evolutionary concept, when discussing DITA with them, than slapping on the tags. If they start to understand the power we're unleashing in their content, they may go for the patient, longer route. Yes, I've got my rose-colored glasses on now.
Larry Kunz
Friday, January 20, 2012 12:11 PM
I agree: we mustn't mislead a client into thinking that a DITA conversion is a cosmetic or band-aid approach. It really is an evolution. Hey - do you think that's why the D in DITA stands for Darwin? ;-)
Julio Vazquez
Friday, January 20, 2012 12:20 PM
By Jove, I think you've got it!
Friday, January 20, 2012 2:07 PM
One way or another, you're going to end up doing a content audit, whether you planned to or not. It could be pre-conversion, and you end up converting only the valuable content. It could be post-conversion, as you sift through documents, realizing that many of them aren't worth the effort to clean up any further. It could be post-translation, in which case you've waited way too long. If you think content audits bring too much pain, try not doing one. But, there are reasons why poorly structured content got created, why content got duplicated, why it was allowed to become outdated. All of these are, at their root, cultural problems, not technical problems. New tools don't automatically mean we start doing things differently. What needs to happen, as soon as possible, is culture change: Borg: "Your culture will adapt to service us." These cultural problems manifest themselves in our documents. The thing is, when viewed from the perspective of the old culture, it's harder to recognize all that's wrong. A content audit assisted by someone already steeped in the new culture can be the start. Otherwise, conversion and cleanup can be very eye-opening experiences, although somewhat more painful. Some of us just have to learn the hard way.
Julio Vazquez
Friday, January 20, 2012 2:33 PM
Right on, Mike! There will be an audit at some point or the other. When considering moving to DITA, it should be before and not after to minimize the effort involved. All too frequently is the mind set of "We'll do it later" and later never comes. (Isn't there a song, Tomorrow never comes?) Yes, there needs to be a cultural change. Consultants should help educate and ease the pain involved in the change. The problem, as Larry points out, is that there are times the client can't see the long-term benefit by the larger up-front expense. But, like the Borg, we will get their culture to adapt to us. :D
|
|
|