It’s been a couple of weeks since I posted about my team’s search for an enterprise authoring strategy. So far, we’re just as split as ever about the problem. It seems that you can go four separate routes: DITA, HAT, Web, or Wiki. Here are some of the paths and difficulties we’re encountering. DITA DITA has traction as a new standard format for help authoring, … more »

Some of my projects include community-involved documentation. When you work for a church, it’s not hard to find dedicated members willing and committed to sacrificing a few hours for a higher cause. To harness community efforts, I gathered up a large pool of volunteer names and formed a listserv. I communicated project needs with the listserv members and asked for help. Despite some contributions, the … more »

Sarah O’Keefe’s guest post — The Role of the Gatekeeper is Changing — on Peg Mulligan’s blog is interesting. Sarah writes, The Internet is removing the traditional gatekeepers for content. This may seem obvious, but its implications in my life have been profound. I majored in English and then earned an MFA in creative writing. After graduating, I gathered up my best essays and sent … more »

Catalyst 4: Wiki Manager As if I wasn’t already doing enough, I also started to wear another hat: wiki manager. It turns out I failed in this role, but I’ll still include it here because it segues into another topic I want to explore, which is spreading yourself too thin. At the beginning of this essay I mentioned the community projects we started up. When … more »

Today I spent a rather lonely day writing documentation. I had one team meeting, during which our team gathered for what seemed like a brief second. We then departed back to our respective portfolios, most of us working alone and in solitude toward some distant documentation goal.

Recently Will Sansbury and I gave a webinar to STC community leaders on chapter and SIG websites. Rather than giving a static, one-way presentation about theoretical concepts with web design, or boring people with technical details they probably didn’t care about, we held the webinar more like a design review workshop, not too different from a writing group workshop. Although I spent three years in … more »

Recently our technical writing team at work (Information Strategies and Design) started holding regular design reviews. The review sessions are patterned after meetings that our interaction designers hold regularly, in which they get together and critique each others designs and approaches toward user interfaces. In our design review sessions, a couple of members from our eight-person team share what they’re working on and ask questions … more »

Recently I’ve been working on a simple calendar project that uses a wiki for documentation. Although I’ve heard a lot about using wikis for documentation, and have even used them in the past, I ran into a few surprises this time.

Although many people put blogs and wikis in the same social media category, blogs and wikis are actually quite different. Blogs are individually authored mini-magazines or journals where one author (or sometimes a small authoring group) crank out article after article (or entry after entry) usually with a common theme. After each article is published, the article is considered done and the author moves on … more »

[amazon-product align="right"]0982219113[/amazon-product][Audio clip: view full post to listen] Download MP3 Length: 40 min. As a follow-up to my review of Anne Gentle’s book, [amazon-product type="text" text="Conversation and Community: The Social Web for Documentation"]0982219113[/amazon-product], I also interviewed her for a podcast. Now you can listen to Anne talk about some of the concepts in her book in a more personal way through the headphones of your … more »

One of the perks about being a blogger is that authors occasionally send me their books to review. Recently Anne Gentle sent me her new book, Conversation and Community: The Social Web for Documentation. Anne’s book is particularly important because it addresses the situation of the technical writer today, with the web in the state it is — user generated, filled with blogs, wikis, Twitter, … more »

I’m trying something a little new on my blog. Previously, every time I read a cool post, I submitted the link to Writer River. The problem with that, however, is that posting to another site isn’t such a smart search engine optimization (SEO) strategy. Using the Writer River method, people who follow trackbacks don’t follow them back to my site (idratherbewriting.com), but rather go to … more »

When choosing a blog platform, you have a variety of options: Drupal, Movable Type, Typepad, Blogger, Joomla, Expression Engine, WordPress.com, self-hosted WordPress, and others. But when you start researching the options, WordPress seems to have at least 10 main strengths over its competitors:

Write Answers, Not Documentation

Does Your Documentation Suck?