May 22, 2013 Update: This post generated a lot of controversy, and I believe part of the controversy could have been avoided if I had articulated my ideas better. I’ve gone through and updated parts of this post by adding notes. 5/22 note: Previous title was “Structured Authoring Versus the Web”. However, of course the Continue Reading »
In my previous post, Do Short Topics Make Information More Findable, I argued that shorter topics make it more difficult for users to find information. I ended the post by saying that topics that are more substantial make content more findable. But how big should the topics be? Obviously not the length of a book, Continue Reading »
In my last post, which now has more than 80 comments, I noted that authoring with DITA seemed to encourage authors to create a lot of little topics. DITA experts chimed in to say DITA doesn’t constrain users with topic length in their outputs — authors can combine topics as needed. However, one commenter noted that short Continue Reading »
I’m currently exploring the possibility of authoring content in DITA (using a tool such as easyDITA), publishing to an HTML web help output (through the DITA Open Toolkit), and then importing the output into Drupal (through some Python scripts someone has created). This sounds like a good workflow to me, but I’ve kind of run Continue Reading »
I’m continuing to make my way through James Kalbach’s book, Designing Web Navigation. In chapter 2, he says the structure and format of content helps users anticipate the meaning of the content. He writes, The human visual system naturally seeks structure in information, often very rapidly. Scientists refer to this as “pre-attentive” processing. This occurs Continue Reading »
The following is a guest post by Neal Kaplan, a technical writer at Zuora, Inc. Another post about wikis? Why not! Wikis are great! Just to set the stage, I’ve been a technical writer for a while now, working for software companies in Silicon Valley. (In fact, I often forget that there are technical writers Continue Reading »
In my last post on wikis, Mark Baker added an astute comment: I’m not a wiki fan myself — I’m a structured text guy bred in the bone — but I am fascinated by the trend, and by the variety reactions to it. Wikis started more as a cultural statement than a technology. They were Continue Reading »
It’s been about 9 days since my last post, and yesterday my colleague leaned over and asked why I hadn’t been posting — was something wrong? He himself has been working on a novel, so he hasn’t posted anything for a month. No, nothing is wrong. I always chuckle when I see blog posts in Continue Reading »
If you want to be able to sort information by various classification schemes, such as by most popular, or by role, or by problem, your content has to be chunked in a granular enough way to facilitate the various means of sorting. Consider a work that is one large book, with no chunks at all. Continue Reading »
My colleague Ben Minson wrote a post about why tripane help is a relic of the book-paradigm documentation age, and how it can limit us from taking advantage of other web technologies. See Why I Don’t Like Tri-pane Help. As a quick definition, tripane help is the standard webhelp HTML output that has several frames Continue Reading »