Moving Beyond the TOC in Organizing Help Content — Illustrated Edition
May 22, 2013 » 15 Replies
What Does Content Re-Use Look Like in a Web CMS?
May 17, 2013 » 4 Replies
One challenge I’ve recently been considering is how to handle content re-use on a web content management system, such as Drupal, Joomla, WordPress, or some other web platform. Let’s say you’re writing about ACME widgets and have three different audiences: ACME developers, ACME sales people, and ACME administrators. All your help content is hosted on Continue Reading »
Is Structured Authoring (like DITA) a Good Fit for Publishing on a Website?
May 14, 2013 » 43 Replies
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 »
Why Long Topics Are Better for the User
May 6, 2013 » 6 Replies
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 »
Do Short Topics Make Information More Findable?
May 5, 2013 » 11 Replies
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 »
Does DITA Encourage Authors to Fragment Information into a Million Little Pieces?
April 22, 2013 » 96 Replies
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 »
How Can a Technical Writer Develop a Love of Programming Code?
April 18, 2013 » 15 Replies
Anne Gentle, one of my favorite bloggers, recently wrote about the diverse backgrounds of the technical writers around her — see Developers, Writers, and First Jobs. In her post, she included a job description for a “Microsoft Programming Writer.” It’s kind of a mind-blowing description. Here’s what Microsoft is apparently looking for: You are comfortable Continue Reading »
How Do You Gamify Writing?
April 17, 2013 » 9 Replies
A couple of weeks ago, I wrote about Gamifying Chores. While chores are easy to quantify and measure, activities such as writing have a different dynamic. How do you gamify an activity that has so many complicated facets, purposes, and forms? Blogging is one way to gamify writing. Blogging introduces game elements to make writing more fun. Continue Reading »
Why Do People Rank High on the MindTouch #Techcomm Influencer Report?
April 11, 2013 » 27 Replies
MindTouch recently released their report about the most influential people in techcomm, and I was happy to rank so high. I’ve had varying reactions to this report for the past several years. The first year MindTouch released the report (2010), I thought it was an ingenious marketing tactic. Within days after the initial release, the company Continue Reading »
Why Does Content Become Disorganized?
April 9, 2013 » 11 Replies
Why is it that writing can start out clear and organized, with a coherent logic and order, but then progress toward fragmentation, disarray, and messiness? How do you move from an ordered content system to an unordered content system? The movement towards disorganization describes the natural direction of many things. Our houses get messy each week Continue Reading »