This past year I learned a few things. As I approach 2012, I’d like to note what 2011 taught me: Writing documentation in a wiki suits me for the same reasons I enjoy interacting on the web. The web is interactive, alive, dynamic, collaborative, fresh, and unlimited in potential. A wiki, being online, allows me to partake in the same game-like, community-rich environment that I … more »

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 a tool for the democratization of content, the intent being … more »

Last week I was feeling a bit stretched out about not having enough time to accomplish everything I needed to do. Granted, I gave several webinars to a total of 2,000 people, which was somewhat stressful, but I was more stressed about the fact that the help material I’d created could have been much better if I had only more time to focus on it. … more »

Two powerful trends in tech comm seem to be moving in different directions: social media and structured authoring. I have used a wiki as my primary format for documentation for the past year and a half. I tried to corral a group of volunteer technical writers to edit and update the wiki, because I embraced the idea that collective intelligence beats the individual thinker in … more »

I was talking to a colleague today about wikis when he mentioned Google, and how Google has such a brilliantly simple solution that allows users to find content. With Google, there’s a search box. The users type keywords they want information about, and most of the time Google returns brilliantly relevant results. While some credit is certainly due to Google’s Pagerank algorithm, what enables findability … more »

Alan Porter’s Wiki: Grow Your Own for Fun and Profit, published by XML Press in October 2010, provides an excellent introduction to wikis. This is a short, easy-to-read book spanning about 150 pages. Alan has a keen sense of organization and liveliness in his writing. He carries the gardening metaphor throughout the book, ending with five solid case studies and an extended response to common … more »

One of the sites I’m working with lately at my job combines a forum (vBulletin), blog (Joomla), and wiki (Mediawiki) into one experience. Each of these tools does a great job at what it was designed to do. They’re three separate platforms skinned and linked together. I used to think the site was a hodgepodge of software platforms, but now I see that these three resources … more »

In my last series post on organizing content, I argued that traditional help authoring tools will be replaced by web platforms suitable for authoring help content. Web platforms have many advantages over help authoring tools. They provide everything from search engine optimization to interactivity and social media integration. Some of the more common HAT features, such as single sourcing and print, may not be as … more »

Yes, I am continuing this series on Organizing Content, so if you are tired of it, check back in a while. My goal is to reach 100 posts on the topic. An Electricity Fast First, a brief bit of news. All the lights in my house are off because Jane wants to do an electricity fast. It’s a Thoreauvian experiment to see what you gain when you … more »

[Audio clip: view full post to listen] Download MP3 Length: 45 min. Powerpoint This podcast on Trends in Technical Communication is a recording of a presentation I gave at the Missouri State University Workshop for Teachers of Technical Writing on April 22, 2010. Although trends in technical communication could cover a variety of topics, I chose to focus on four trends: hybrid roles, social media, … 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 »

I spent much of last week with my head inside a Mediawiki skin (when I probably should have been working on another project). I’m not entirely sure what it is, but I sometimes get fixated by technical problems I can’t seem to solve. I first customized the FraternalRelief Mediawiki skin to match my organization’s home page. My customization wasn’t too bad, but I saw a … more »

I mentioned in a previous post that I think traditional help authoring tools are becoming less and less viable for robust software projects in which multiple subject matter experts in distributed locations need to collaborate, and when these same subject matter experts need to own the documentation after release. This wasn’t just a fleeting thought. I spent the last couple of days last week getting … more »

If you work in a large corporate environment, you’re familiar with restrictions about accessing production servers to make updates or additions to your help content. To touch anything on a production server, you have to go through the change release process, which requires a lot of paperwork and procedural hassle. Almost no project manager sees documentation as important enough to release a new version of … 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.