CIDM CMS/DITA 2013 Conference Report, Part 3

It was the second day of the conference and I was not fully awake yet, but my first talk of my day had the demanding name of “Managing Cross-Publication Links Using Shared Key Definitions.” It was by Eliot Kimber, and he asked us if we were ready for the hardest part of DITA. So I tried to rev up some cognitive horsepower as best I could. Kimber is deeply into this subject and he showed many slides of all text and no graphics while precisely describing this area, its background and its problems, and it was really quite good. I almost feel like a link expert now.

Casey Jordan, founder of the easyDITA CMS, gave a talk about applying the programming practice called “continuous integration” to documentation. It was very technical and went at a fast pace (these talks last only about 35 minutes with a few minutes of questions, so presenters usually have to hustle). Jordan called it documentation-driven development. This is an interesting idea and would probably work well if you could implement it properly. Interesting technical details: He uses the open source exist-db XML database, and uses XQuery to query it.

(Sorry I am attending so many of these technical geek-out talks, but those are my interests. The conference does have a much wider range of subjects for most levels of interest and technical expertise. Find more info on the conference site. I have no commercial connection to them, by the way.)

Kristof Van Tomme from Belgium gave a nice overview of late-model web development techniques that make it easier to support the profusion of mobile screen sizes some of us deal with today. These techniques are called responsive design and adaptive content, and he talked about how to implement them with the Drupal content management framework. There was some DITA in there too, because Kristof continues to do work on integrating DITA with Drupal.

I attended a talk called “Global DITA” by people who work for a very large agricultural equipment company in the Midwest called AGRO. They have a huge DITA installation running on SDL Trisoft and they went over how they implemented it, including how they are cleaning up their considerable translation/localization requirements. They ran into friction from writers who were not happy with the changes required of them. They managed to handle the friction nicely by enlisting one of the friction-makers to help lead the effort to change to DITA. I liked hearing the information architect from this farming equipment company talk, with a straight face, about how her company’s information was in “silos.”

I listened to a group from a very big payroll processing company go into the details of how they saved tons of money and increased their translation quality by taking the chaos out of how their company did translations. Jargon Watch: Apparently their term for “paychecks paid to people” is “pays”, as in “We do 4 million pays annually.” They don’t seem to have employees, but they do have 57,000 “associates.” They are also hip to this late-model use of the word “spend”: “We decreased the spend for translations by 40%.”

This translation talk was interrupted by someone who came in and said we had to move to another part of the building because of a suspicious package found downstairs. We stopped everything and quickly moved out. It turned out to be a false alarm and we got back to our talk about 10 minutes later. People are understandably spooked about recent sad events in Boston, and Providence is about 50 miles from there.

Later I saw a talk on efforts to standardize change markup in DITA (and XML in general). And then a talk on ways to sell a marketing department on using DITA. Separating designers from their InDesign is sure to be an adventure.

End of conference day, nothing else on the agenda. I was lucky enough to be invited to a very nice dinner with drinks at a restaurant by a generous CCMS vendor.

Last day of the conference tomorrow!

Technical communication to the rescue in my hotel room:

2013-04-16 07.42.17

CIDM CMS/DITA 2013 Conference Report, Part 2

First day of the conference! Here is the crowd at the keynote presentation. We were told that this is the largest attendance ever for this conference, at 345.

2013-04-15 08.10.29

The keynote speaker was a fellow named Gerry McGovern, who made a good argument for not worrying about how many hits your website gets, and to instead focus on pushing to the top of search responses the things that your users need most. Did you know that the Microsoft website has about 15 million pages, and out of those about 4 million have never been accessed by anyone? His presentation was very entertaining. He has an Irish accent, and I had some quiet juvenile joy when when he pronounced “third cousin” as “turd cousin.”

Then the regular presentations started. I chose Severin Foreman’s talk on how he became an information architect and what that entailed. I realized that being a DITA IA probably requires a good many people skills as well as technical skills.

I next attended a presentation called “DITA Mythbustin'” by Tom Magliery of JustSystems, makers of the XMetal XML editor. He went over a bunch of beliefs about DITA such as “It’s only for large companies” (he said false) and “It’s too complex” (he said true, but not hopelessly so).

I saw another talk or two and then there was lunch, where they had a bunch of tables set up for “Birds of a Feather” lunches at each table. One person at each table moderated a conversation about a different DITA-related topic, and there were dozens of them. I chose one where Edwina from Kaplan Publishing in NYC talked about getting DITA output from InDesign.

After lunch I saw a talk by two guys from Citrix (Patrick Quinlan and Dustin Clark) who have created this wild DITA setup where a lot of writers author in plain MS Word but use a few special codes in the text, and then they run it through this custom web-based system that converts the Word files into DITA topics, which are then output to various things like PDF and mobile-friendly HTML5 using the DITA Open Toolkit. Then I heard Robert Anderson of IBM talk about what’s coming in the next in the next version of DITA (1.3). They’re trying not to overwhelm people with as many changes as were made in the 1.2 version, but there are a few interesting things coming.

I attended a talk by Matt Kaatman, who gave a fascinating (to me) history of the DITA Open Toolkit and talked about how you can help with its development. All help is welcome, and I would like to do this at some point.

My last talk was by Jeff Engle from Xerox. He implemented several highly successful DITA-based systems at Xerox. Two of these systems were in somewhat uncommon areas for DITA: Human Resources and training. He is getting a 50% reuse rate for the HR project, which is huge. In this HR project, some of the docs they were converting went back 100 years. One of the employee benefits back then was access to an “iron lung.”

Here’s a shot of many (or maybe even all) of the members of the OASIS DITA Technical Committee standing around yakking on a break. From left to right: Eliot Kimber, Amber Swope, Kristen Eberlein, Kristof Van Tomme (not on the committee), Michael Priestley, the back of Don Day’s head, and Robert Anderson looking slyly at the camera. Robert is the chief architect of the DITA Open Toolkit.

2013-04-15 15.55.51

As if all of that wasn’t enough, at the end of the day there was a vendor’s reception, which meant more alcoholic beverages and some really good hors d’oeuvres like coconut shrimp. I went around to the vendor booths with my beer and got a bunch of demos and exchanged more business cards. I noticed that many companies are looking for ways to enable easy authoring in DITA for people who wouldn’t go near a full XML editor. There wasn’t enough time to get to all of the vendors and I was getting pretty beat by this time, so I went to the hotel to write this before I dropped.

I received a massive amount of DITA (and related) info today, and there is still a day and a half left. But I’m not tired of it and I look forward to tomorrow morning!

 

CIDM CMS/DITA 2013 Conference Report

Hello, I’m your guest blogger! I volunteered to do some on-the-ground posts about the CIDM CMS/DITA 2013 conference in Providence, Rhode Island. This is the first installment.

It’s Sunday April 14 and I got up this morning at 330am to catch my 600am flight from LAX. I arrived at my hotel in Providence this afternoon. Providence is an old and gorgeous little city. Here is the view from my hotel room:

providence

The conference starts tomorrow, but tonight I attended a reception for attendees with drinks and light food. Here is the swag they passed out as I signed in: a nice backpack sporting the CIDM logo, and my attendee badge.

swag

There was a lot of drinking, eating and talking going on. I really should have taken some pictures of the room. I will make up for this later. I had a beer and ate a lot of green and red peppers while walking around the room introducing myself to people and exchanging cards. I’m here to learn things and promote my services. It was very fun to meet Radu Coravu and George Bina of SyncRO Soft, makers of the excellent Oxygen XML editor. They are from Romania. I also talked to Eliot Kimber, markup wrangler par excellence and one of my heroes. He had flown in from Austin and was wearing a kilt. I also met and talked to Don Day, co-chair of the OASIS DITA Technical Committee. He was one of the original people working on the DITA standard, and I enjoyed discussing using DITA on-the-fly for websites. I’ll guess the room had over 200 people in it at its peak.

Tomorrow morning starts at 7am for a provided breakfast, and then the speakers and presentations start! I’m excited! More tomorrow.

Please Welcome Guest Blogger Mark Giffin!

At last week’s PDX DITA meetup, we were able to Skype in LA area DITA consultant Mark Giffin as an honorary Portlander. (He’s even planning on growing some interesting facial hair for future Portlandian meetups.) There were some great informative discussions and on learning that he’s attending the CIDM Content Management Strategies/DITA North America conference this week, we were able to sign him up to report in from DITA Central. We’re looking forward to hearing about what you’re learning, Mark!

DITA-Related Job at Intel

This just in from Benjamin (@WealthOfIdeas). Thank you, Benjamin!

===

XML/DITA Expert Technical Writer – 708117

Description:

The XML/DITA Expert Technical Writer will help conceive, design, and implement documentation for multiple outputs using a single source XML based system. This person will partner with Documentation toolsmiths, writers, developers, and third party vendors to establish an information architecture documentation and implement it in the Mobile Communications Group. This includes converting existing content to a DITA-compliant system using SDL Trisoft, training users on XMetaL, managing meta data and document maps, and working with a vendor to deliver DITA compliant content to a dynamic web based delivery system.

Qualifications:

Candidates should possess a Bachelor’s degree in English, Technical Writing, Technical Communications, and Engineering.

Minimum Requirements:
5+ years experience in technical writing, 1+ years managing content for a product, 1+ years of experience working in an XML environment.
– Good understanding of information architecture/information modeling concepts and procedures and familiarity with BUs content – with ability to undertake a BU content audit to define BU content models.
– Good understanding of graphics file types and their appropriate uses.
= Good understanding of Technical Writing principals, including planning, project management, editing and publishing.

Preferred Requirements:
The XML/DITA Expert Technical Writer is an essential role for every program.
The ideal candidate should have the following skills:
Solid understanding of XML, Schemas, and DTDs (creating and editing)
Solid understanding of topic-based authoring and information mapping concepts as they relate to DITA.
Solid understanding of the DITA standard, with knowledge of how the DITA DTDs should be customized and deployed (i.e., specializations, constraints, DITA-OT plug-in creation).
Solid understanding of the DITA Open Toolkit with knowledge of how to customize it (i.e., DITA-OT plug-in creation) to enable new transformation types.
Solid understanding of XPath and XSL (both XSLT and XSL-FO)
Ability to identify and implement corporate trademarking and branding requirements in DITA-OT outputs (PDF, HTML, CHM) using XSL.
Familiarity with ANT build file creation and modification.
Familiarity with XML validators (e.g., Xerces) and XSL processors (e.g., Xalan, Saxon).
Familiarity with XML authoring tools (such as XMetaL and FrameMaker) and ability to customize configuration files (i.e., CSS, CTM and other XMetaL configuration files; read/write rules, structapps files, templates, EDDs and other FrameMaker configuration files)
Familiarity with SDL Trisoft, including file repository structure and access control, Publication Manager and Condition Manager clients, and the Web Client.

Apply at http://www.intel.com

Undiscovered Footnotes to The Waste Land (also, April Meetup)

(See details of the April meetup in the sidebar of this website. Hope to see you there! We’re going to talk about documentation for mobile devices this time.)

April is the cruellest month1, breeding
Lilacs out of the dead land, mixing
Memory and desire, stirring
Dull roots with spring rain2.
Winter kept us warm, covering
Earth in forgetful snow3, feeding
A little life with dried tubers4.
Summer surprised us, coming over the Starnbergersee
With a shower of rain5; we stopped in the colonnade,
And went on in sunlight, into the Hofgarten,
And drank coffee, and talked for an hour6.
Bin gar keine Russin, stamm’ aus Litauen, echt deutsch7.
And when we were children, staying at the archduke’s,
My cousin’s, he took me out on a sled,
And I was frightened.8 He said, Marie,
Marie, hold on tight. And down we went.9
In the mountains, there you feel free.
I read, much of the night10, and go south in the winter11.

NOTES
1This product release is going to be brutal. Glad we have a PDX DITA meeting a week before to break up the agony.
2Unless it’s awesome! This time, maybe there will be no typos and the programmers will have told us everything that changed!
3Oh dammit. That module no one has touched since last December.
4Well, perhaps not so little anymore given our diet of breakroom potato chips.
5Quelle surprise. You say you live in Portland?
6Those product managers will talk your ear off. But they paid for the coffee at least.
7No, we don’t have a Lithuanian translation yet, but please check with Sales for an update on our future i18n road map.
8Even in childhood, many technical writers are drawn to low-risk situations and fear lack of control.
9That wild sensation of careening toward the future that is unleashed when you press Enter after typing an ant command.
10Build logs, mostly. But sometimes Kant, or the 50 Shades series.
11Totally springing for the campsite with the showers this year.

Your Year in DITA (come tell us about it. . .)

Props to Josh from NetApp for last meeting’s amazing breakdown of ant build errors during PDF generation. Wow, we learned a ton, which always makes us want to learn more, of course, so…

In the spirit of the holidays and all those Year in Review, Best of 2012, and other such recaps, we thought it would be fun to hear about your year in DITA. In other words, what did you or your team do with DITA in 2012? Maybe you were just getting started and had to convert several kajillion Frame files. Maybe you got a new content management system that presented all kinds of challenges. Maybe you did something kinda neat with DITA that others could learn from. Let’s do a simple roundtable and hear a little bit from each person. Sound good?

And even more in the spirit, Marya and I will bring some mulled cider and a roast chicken to share. If you want to bring something, awesome, but don’t feel obligated, just come!

Hope to see you! Meeting location and other details are in the right sidebar.

Upcoming Meetings

For our upcoming June 13th meeting, Roger Hadley, Senior Technical Writer and Team Leader at Grass Valley Live, is going to give a short presentation about keyrefs: we’re excited to hear all about this subject because we haven’t started to implement them yet. Feel free to bring your own topics of interest for discussion after the Q&A. And if you’d like to present at the next meeting, go ahead and suggest it in blog comments or email Marya at marya.devoto@jivesoftware.com.

As always, we’ll be providing food, beer, artistically bitter griping about PDF production, and a nice view of Powell’s Books from our fifth-floor break room in the Jive Software building at 915 SW Stark Street.

Meetings Are Now Quarterly

Note the new schedule in the right pane of this blog: we’re shooting for quarterly meetings, since monthly events apparently require too much of a commitment given the glamorous, fast-paced lives of tech comm professionals.

 

Intermediate DITA Education: What Would You Want to Know?

At our meeting two Wednesdays ago, my colleague Leona Campbell shared her experiences taking an Advanced DITA class, which led into an interesting discussion of what post-basic DITA education means these days. Anecdotally, it seems early adopters of DITA have tended to be self-educated fearless types who are comfortable learning from the spec and reaching out to user groups for help from other highly technical users. DITA workshops and classes, however, often seem to cover the concepts of structured and topic-based authoring, what the DITA OT is, and some simple authoring and conversion tasks: they also tend to have a focus on migration, probably because so many DITA projects start with the problem of moving all the old junk out of whatever format it’s in. Finally, there’s often an evangelical component, because it’s no small thing to stop doing whatever you were doing before, and do something as skills-intensive as DITA instead.

However, as DITA matures, its users are a more diverse crowd with more diverse needs. (For example, all three of us writers at Jive Software inherited an existing DITA implementation rather than spearheading a migration.) In our discussion, we said we’d like to see some classes covering the structure of the toolkit and how it can/should be modified for real life implementations. Some more ideas that were floated:

  • What are the best practices for file setup?
  • How should you plan for upgrades?
  • Is it realistic to store all your files in the same directory?
  • How do you know when you need a CMS, and if you haven’t sold your company on having one yet, are there any best practices to avoid making it harder when you finally do?
  • How do filtered builds work and what are some useful examples?
  • What are some common mistakes of DITA implementation and how could you avoid them?

What would YOU like to learn/wish you had learned from DITA training, versus the school of hard knocks? Feel free to respond here.