The 80/20 rule, or Pareto’s Principle, states that 80 percent of the effects come from 20 percent of the causes. Applied to help authoring, this could mean that from 100 help topics you write, about 20 of the topics will be viewed 80 percent of the time. Designers recognize the applicability of the 80/20 rule on design. Heat maps show that people only focus on … more »

When I first started as a technical writer, a senior writer taught me how to write documentation. Her approach, which aligns with the traditional way of doing technical writing, generally followed these steps: Get involved as early as you can in the software development process. As soon as prototypes are available, or a functioning development environment, start the documentation process. Think of all the main … more »

One of the findability features in our help systems that we often overlook is the breadcrumb. Breadcrumbs typically sit above the page title and highlight the hierarchical path that leads to where you are. Here’s a screenshot of a typical breadcrumb, taken from Adobe Illustrator’s help: Greg Nudelman discusses breadcrumbs in one of his chapters in Designing Search: UX Strategies for eCommerce Success. This post … more »

I recently had a project with a small group of users, maybe 35. I joined the project about a month before the scheduled release. I wasn’t sure what kind of help the app needed, or what format. A wiki? Screencasts? Online help? A short PDF? I talked with the lead customer, and he hadn’t given much thought about help. I talked with the project manager, … more »

Most people take time off during the holidays, so if you don’t, you end up mostly sitting alone at work, wondering why you’re not taking time off too. I wanted to follow Penelope Trunk’s advice about pursuing your pet projects while working during the holidays, but instead I was trying to finish a project with an end-of-year deadline. The project I’m working on is critical, … more »

It seems most of the conversations in our industry today revolve around value. If you go to stc.org, the large graphic at the center of the site says “The Value of Technical Communication.” (Given the recent events in the STC, to me the graphic really reads, “The value of the STC organization.”) At any rate, technical writers have been talking about demonstrating value to employers … more »

[Audio clip: view full post to listen] Download MP3 (to download, right-click and select Save Target As) Length: 30 min. In this podcast, I talk with Mike Hughes, second vice president of the STC, about his latest UXMatters article, “Straight Talk: Surviving Tough Times as a User Assistance Writer.” We talk about how to make help more valuable, more worthwhile and user-focused, so you don’t … more »

A friend of mine sent me a video that provides instructions for converting your TV signal from analog to digital.

Ever since I came back from Doc Train West and had my epiphany about the transformative, empowering nature of user knowledge with the tech writer role, I’ve wanted to build stronger connections with my users. Having extensive knowledge of user behavior can make you a valuable asset on any project team, allowing you to deliver key advice on application design and development. Additionally, as in … more »