Hi,

Using this forum for my annual BCIT Comm 2206 reality check on who out there is actually generating XML-based documentation.

Findings from previous years were that there are many XML-based software development projects out there, but the need to actually publish user documentation as XML is low for the scale of IT companies in BC.

XML seems to fit the needs of high volume information enterprises like IBM and Boeing. To my knowledge, the largest project of this kind was at the Open Learning Agency (OLA), but I think that was disbanded when OLA was reorganized.

So, apart from general DITA buzz, are there any real-world XML publishers in our midst?

Cheers,

Ben Hechter

Like you I have heard the buzz, but I’ve only seen XML in operation in one case: PMC-Sierra uses it to generate register descriptions for their semi-conductor chips. I was involved during my tenure there, which ended in 2005. I can try to answer any questions you have, or you can approach Tony, who works there currently and also follows this forum.

I like your “reality check” concept. I freely admit that except in a few extremely narrow cases like the register descriptions (where it’s a godsend) I am not able to imagine a case where XML would resolve more problems than it creates. The “reuse strategy” argument seems to be mostly hyphothetical, although a number of large companies are using it as a transition medium between a database and a wiki, for example. Lombardi Software (pretty big) is using it this way.

I’ll watch this thread with interest, thanks for a great question!

Regardless of company size, it seems to me that if your content requires localization and translation, the business case for implementing an XML/structured authoring solution would be pretty strong.

Tamara

Ben Hechter - 26 June 2008 07:32 PM

So, apart from general DITA buzz, are there any real-world XML publishers in our midst?

Hi Ben. I think we should clarify. XML is for authoring. While some innovative companies could use the same XML source file to produce their print PDFs, website html, online help, AND downloadable device programming data, I don’t believe a lot of companies actually publish their XML source.

Now if we reword the question toward “real-world XML authors,” I could list several thousand, though not all of them in the lower mainland. Join the STC single-sourcing list (the most active STC SIG list right now) and check out the membership roster. Even removing the STC members from the 2000+ members of the DITA Users Yahoo group, leaves over a thousand. Not to mention the participants of the source of all things DITA.

As far as “real-world in our midst”, I have to say “no comment”. I talk too much as it is on these forums. Buy me lunch and I’ll tell all!

I keep hearing about companies who are authoring in XML, some large, some smaller. I never think to note the names. The ones that come to mind are Kodak, SAP (formerly Business Objects), Redback (or they are migrating to it), and a number of smaller, nimbler start-ups that started with XML because they started their documentation efforts with developers, who used XML, and then handed it over to tech writers (sometimes, the tech writers undid the XML and back to old school, but that’s another story).

Funnily enough, I had some developers give me some XML for an SDK. The software tool I was using would not allow me to keep that XML. I actually had to store the XML files outside of the help project so the HAT wouldn’t mess with them. But then every time I compiled, I had to copy this folder in. It made an automated compile and distribution more difficult. That sucked.

In all the contracting I’ve done, there are very few companies who are doing localization work or just don’t want to think that far ahead (potentially 3-5 years ahead). So I recommend tools that also come with a translation component that they don’t have to buy right away but the option is there. A bigger content management tool isn’t in the sites for these companies. However, I’m working with smaller companies (and don’t really want to work for BO or is it SAP now or is it BO-SAP?)

Theresa