Recently in Technical Documentation Category
On Wednesday, June 13 at 1:00 EST, Senior Analyst Bill Trippe will be doing a Webinar with Medtronic and the XMetal folks at JustSystems.
While documentation is a necessary deliverable for all companies, its value and contribution to bottom-line business results is often underestimated and overlooked. For Medtronic, one of the world's most innovative medical device manufacturers, documentation is much more than a checkbox on a product release timeline - it is a direct link to customer satisfaction and patient well-being. Medtronic's Rob Kimm will discuss Medtronic's approach to delivering a better customer experience while also ensuring compliance with regulations that impact technical documentation.
Prior to using DITA, Medtronic had a decentralized, heterogeneous environment that slowed production and resulted in redundant workflows. Seven project deliverables were developed in 5 different tools, and the mutually-exclusive tools allowed for little to no ability to achieve true reuse of common content. They now can reuse common content across deliverable types, which has led to great efficiency, accuracy, and consistency.
To register for the Webinar, please visit here.
As our readers know, we are long-time advocates of open-document formats. Over the past couple of years, we have written a great deal about DITA and formats like ODF, but we also have a lot of experience and interest in DocBook and vertical DTDs such as J2008 for the automotive industry and the various DOD standards. We are clearly reaching a point where interoperability among these standards has become an issue. Organizations are more diverse, more likely to be sharing content between operating groups and with other organizations, and more likely to be sourcing content from a variety of partners, customers, and suppliers. Needless to say, not all of these sources of content will be using the same XML vocabulary; indeed, even two organizations using DITA, for example, will likely have specialized DITA differently.
With this need for interoperability in mind, OASIS has announced a new discussion list, regarding a possible new OASIS Document Standards Interoperability Technical Committee (TC). Details on the list, including how to subscribe, can be found here.
Bob Doyle alerts us to the next meeting of the Boston Area DITA Users Group. On Tuesday February 13 at 6:30 pm, Judy Kessler will present, "How Sybase Made the Business Case for DITA."
The meeting starts with light snacks and networking at 6:30 and the presentation starts at 7:00. The meeting will be at the Information Mapping headquarters in Waltham. For directions, click here. Bob asks that if you are planning to attend, please RSVP to Judy Kessler.
For more information on this and future Boston meetings, check the User Group homepage.
Although I have been out of the technical writing trenches for some time now, I enjoy staying in touch with my techdoc buddies and keeping up with the hot issues. One I remember well is the challenges in the early 90's of single-sourcing documentation for print, electronic, and context-sensitive online help delivery.
Apparently it's still hot, despite the release of RoboHelp6 from Adobe, a tool I remember quite well. This is the first product update Adobe has released since the company bought Macromedia over a year ago. Product reviewers generally agree that Adobe beat the estimated delivery date by months, although there is some confusion over dueling version numbers according to my friend Char James-Tanny over at helpstuff.com. Still, an early release is a good sign in terms of a company's current and future commitment to a product.
On the other hand, product reviewers also seem to agree that "XML does not seem to be a priority." Hmmm. That certainly does not bode well for champions of single-sourcing for multi-channel publishing (although the new version automates hyperlinked PDF creation.) Even more interesting are the passionate responses to an unfavorable monkeyPi product review, including an extremely detailed rebuttal from Rick Stone, Adobe's Community Expert for the product (although he's not an employee...)
Without claiming to have reviewed the product, what I find most interesting is Adobe's focus on source and version control, team collaboration and workflow, and the usage tracking capabilities of RoboHelp Server6. Adobe describes this latter feature as the ability to identify frequently-viewed content, view usage statistics, and uncover search trends.
As we've discussed in numerous posts, relevant content and customer experience are intrinsically related, whether the project is Web site design, localization efforts, or yes, even online help development. (Part 2 of our series on this subject, Small Content Changes, Big Impact takes place on Thursday February 1st.) Assuming RoboHelp Server6 provides the insight into the online help user experience it claims, its value to techdoc departments striving for more "upstream impact" in their organization could be quite significant.
In preparation for our panel on Content Globalization Workflows on Thursday November 30th at our Boston conference, we have created a survey to gauge how organizations are dealing with increasing market demand for localized content.
We hope to see you at this session. But whether you join us or not, contribute to it by answering our survey questions. We'll publish the results in a blog entry after the conference, including the results from our audience survey. Give us your input and you'll be eligible to win a free conference pass for one of our future conferences!
Here is a short URL to the survey you can share with others: http://tinyurl.com/yjy694
Here's what we'd like to know:
1. Which issue is your most pressing business driver for providing localized content to your customers?
2. Who is responsible for purchasing translation software in your organization?
3. What is the most difficult challenge within your localization processes?
4. Do you have one or more content/document management systems in house?
5. Do you have one or more translation management systems in house?
6. If you do not have a translation management system in house, who do you work with to manage your translation processes?
7. If you have both a content/document and a translation management system in house, are they integrated?
8. If the systems are integrated, select the most appropriate description of the integration.
Here is a quick update on next week's event:
New Sponsors & Exhibitors
Adobe has joined us as a Gold sponsor - their Enterprise Solutions and Developer Group in particular. See announcements on some of the new products and features to be shown from our 50+ exhibitors.
New Debates
In addition to our popular analyst session, two analysts will face-off on 7 topics they disagree on in Content Technologies: A Town Hall Debate. And of course, don't forget CMS Idol.
Keynote Survey
The early results from our survey on questions to ask the keynote panel show the topics attendees are most interested in are, in order:
UPDATE: You can see partial final results of the responses to all the questions here, and contribute to the survey here.
Content Globalization
Also, the top write-in question topic so far is on globalization and content management. This is a hot topic at the event - there are multiple sessions covering it, and many vendors showing related products and services - some of them have even put together a Content Globalization Pavilion.
We have over 100 expert speakers covering these and other topics. Conference program .
And don't forget to look into the Content Management Professionals Association Spring Summit
Sarah O'Keefe from Scriptorium noted and commented on a great discussion of DITA and DocBook by Norm Walsh, the guru of DocBook. Norm was a featured speaker at last week's DITA 2006 conference. Norm's discussion is readable and lucid, and if you have been wondering about this question for a while, Norm's post is required reading.
Some of you have likely listened to the excellent technology radio show at MyTechnologyLawyer.com. Gilbane Report Senior Editor Mary Laplante and I will be talking about the upcoming Gilbane San Francisco conferences on content management and digital rights management. The interview will be at 1:00 Eastern time tomorrow, Thursday, February 9, and you can listen live here.
UPDATE: If you missed the live broadcast, you can listen to recorded versions here (Real Media) or here (Windows Media). Among the topics discussed at some length were DITA and Enterprise DRM.
So I will be participating in Wednesday's webinar with Idiom and Blast Radius, "DITA Directions: Topic-Oriented Single Source Publishing for the Web and Beyond." Most of my presentation will be based on our upcoming white paper, Success in Standards-Based Content Creation and Delivery at Global Companies, which is subtitled, "Understanding the Rapid Adoption of the Darwin Information Typing Architecture (DITA)." The white paper focuses on two highly successful case studies of DITA in use at Adobe and Autodesk. Both of these companies have already produced tens of thousands of pages of documentation and Help using DITA. In both cases, the documentation is being simultaneously, or near simultaneously, released in more than 15 languages. The case studies are impressive and offer a lot of insight for other companies who are considering going down this path.
We continue to be struck by the rapid adoption of DITA across the product support marketplace, and are starting to see uses of DITA outside this specific application. We are hard pressed to come up with other document-management or content-management standards or technologies that have enjoyed such rapid adoption and widespread use. So one of my slides, sampled below, has a litle fun with Gartner's now classic Hype Cycle chart. Has DITA avoided the Hype Cycle, where the "Peak of Inflated Expectations" is followed necessarily by a steep drop to a "Trough of Disillusionment"? Here we are in the midst of the hype over DITA (indeed, the standard was only formally published in May 2005), and the case studies show productive work being done in advance of the approved standard. Impressive, don't you think?
I had flashbacks as I sat in the DITA session at the Boston Gilbane Conference. True flashbacks. Back to the days of creating a complex automated compilation "system" to create context-sensitive help for a Windows-based manufacturing control application. Partnered with an object-oriented developer who had better things to do than "play nice" with a technical writer, we managed to build a routine based on Word macros, RTF, Excel, and DLLs to output coded Microsoft help files linked directly to RC files. Convoluted, but it made us proud.
The flashback was not about the coding, although I felt compelled to document the story. It was more about the writing methdology developed with my fellow technical writers. All about standard topics, we developed a core set of help panels based on chunking information into concepts, procedures, reference info (UI and dialog box help) and glossary items. We developed a simple hypertext strategy with non-negotiable rules for what should link to what -- and when. (Ended up with a nice triangle graphic for a cheatsheet.) It worked so well that I wrote and delivered a help standards paper for ACM in.... 1993. Still lives!
So, back to the DITA session, which was excellent -- CM4 featuring IBM and Autodesk -- two real-life and useful stories of implementers from the documentation trenches. Bill wrote about DITA in practice back in October, noting that Adobe techdoc"ers" are also DITA users.
And finally, back to the point of writing methdologies (aka content strategy component,) which I believe is one of the key drivers of the rapid adoption of DITA. DITA = topics = chunking. It is as much a methodology as it is a technology. Information Mapping, Inc., well-known to techdoc folks as a longtime proponent of information organization = usability, clearly agrees. They have rolled their methodology quite nicely into Content Mapper, blending DITA in as well. Their entry into the authoring software market, full of vendors with equally strong heritage, is a good sign for those following the pulse of ECM as strategy (more on that later.)
Takeaways? Information architecture is hot. Technical writer with online help expertise = DITA fan. Getting information from those in the trenches is key -- check out What's New at Gilbane.com and register for a discussion on real-world DITA adoption on January 11th.
Now available! "Beyond Search: What to do When Your Enterprise Search System Doesn't Work, by Stephen Arnold
