Tag Archives: XML

DocBook resurgent: what it tells us about structured writing and component content management

A new XML-based content management system that is not based on DITA. Bet you didn’t see that coming. But I think it tells us something interesting about the two sides of structured writing. Tom Johnson’s recent sponsored post explains the origins of Paligo, a relatively new CCMS out of Sweden. Paligo was developed by a company… Read More »

Why does XML suck?

XML sucks. Don’t get me wrong. All kinds of really valuable and important systems use XML to perform vital functions. But performing a vital function does not keep something from sucking. Lots of people think Windows sucks, but it performs a vital function, and lots of people use it because of that. In fact, performing a vital… Read More »

Structured Writing is Essential for Developer Docs

Tom Johnson wrote a post recently in which he questioned the value of structured writing for developer documentation. Needless to say, I disagree. But Tom and I are not really at odds here. Rather, he means something different by “structured writing” than I do. Structured writing is about content quality, not publishing What I mean… Read More »

Designing topic types

A number of readers have asked me to write about how to design a topic type. Although it can sound complicated, especially if your bring XML schema definitions into the mix, designing a topic type is actually pretty simple. Before we begin, though, set aside all the issues around XML. XML has nothing to do with… Read More »

Content Engineering is Not Technical Writing

My last post, I am a Content Engineer, was taken by several people as yet another attempt to rebrand technical writing. I’m honestly a bit mystified by how people could interpret some of the examples of content engineering that I listed as being examples of technical writing, but Hi Ho. Let me set the record… Read More »

I am a Content Engineer

In the closing keynote of the 2013 LavaCon conference, Ann Rockley talked about the rising importance of content engineering in content strategy. A content engineer, Ann explained, is someone with one foot in the technology world and one foot in the content world. Last year I wrote a pair of posts on my hesitation about… Read More »

A Reference is Not a Topic

Continuing my reconsideration of concept, task, and reference as cardinal topic types, this post is about reference. I planned to call it “A Reference is Not a Table”, as I promised in The Tyranny of the Terrible Troika, but thinking more about it I realized that the issue is really much broader than  that. The… Read More »

A Task is Not a Procedure

In The Tyranny of the Terrible Troika, I complained that the now almost universal trio of concept, task, and reference did not properly represent what topic-based writing and information typing are really about, and I promised to show why each one, as popularly practiced, fails as both a topic type and as an information type.… Read More »