Tag Archives: DITA

Confusing Analytic and Synthetic Truths in Defining Topic Types

Ray Gallon’s recent post, Let’s Break a Tech Comm Rule proposes that we should rethink the idea of separating tasks from concepts. Hooray! It’s no secret that I’m no fan of this separation. Reading Ray’s post, also sparks this thought. It is a common and sometimes catastrophic error to confuse an analytic truth with a synthetic truth. That… Read More »

We Need a New Economic Model for Tech Writing Tools

Tom Johnson’s correspondent, Sam from Canada, asks if tool vendors are not more to blame for the slow pace of change in tech comm than tech writers themselves: Hi Tom, I’ve been enjoying your posts along with Mark Baker’s. You both have good points about technical writing trends. I could be totally wrong, but maybe it’s not the tech… Read More »

Topic size: Finding the narrative minim

The first question we need to address in seeking a theory of topic-based information design is the perennial “how big is a topic”. Whether we are talking about the reusable blocks that DITA calls topics, or about Every Page is Page One topics that are sized for a reader, the question of size is always the first… Read More »

We Must Develop Topic-Based Information Design

There is a lot of talk in tech comm today about topic-based writing, but very little about topic-based information design. This is a problem, because, in the age of the Web, and particularly of the mobile Web, topic-based information design is essential. Topic-based writing is often perceived (and practiced) as nothing more than writing in small,… 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 »

The Tyranny of the Terrible Troika: Rethinking Concept, Task, and Reference

Tom Johnson’s blog post Unconscious Meaning Suggested from the Structure and Shape of Help, includes a graphic showing three shapes of content: Tom Johnson’s “Shapes of Help” graphic. These three shapes are meant to represent the DITA topic triad of concept, task, and reference. I didn’t get it. As I said in a comment on Tom’s blog, I… Read More »

The Design Implications of Tool Choices

Every documentation tool has a built in information design bias. When you choose a tool, be it FrameMaker, DITA, AuthorIt, a WIKI, or SPFE, you are implicitly choosing an approach to information design. If you don’t understand and accept the design implications of your tool choice, as many people do not, you are setting yourself… Read More »

Frankenbooks Must Die: A Rant

I was astonished at Sarah Maddox’s statement, in her guest post Why don’t technical writers use wikis — or do they? on I’d Rather be Writing, that wikis are not good at topic-based writing. Huh? Wikis are all about topic-based writing. In fact, it is the only type of writing they really support. What’s wrong here?… Read More »

The Segmentation of Tech Comm

I was flattered that my post Technical Communication is not a Commodity was used as a catalyst for Scott Abel’s discussion with Val Swisher, Jack Molisani and Sarah O’Keefe on The Changing Face of Technical Communications, What’s Next? I had a fair amount to say in the comment stream that followed to defend my assertion that… Read More »