Tag: technical communication

You may have noticed that I’ve been missing in action lately—at least on Gryphon Mountain, anyway. A couple of related factors have contributed to this.

First, I’ve devoted a lot of my attention in 2011 to fiction. I’m most of the way through my second draft of a novel. During my two-week Christmas vacation a year ago, I wrote over 27,000 words of the first draft. This last vacation, I edited and revised my way through almost the entire second half of it in my second-draft effort. I’m trying to perfect my storytelling skills. Once I complete the second draft, I’ll be reading through it in as few days as possible, just making notes as I go as to what needs fixing. Then I’ll go back and make changes accordingly.

Those who have followed the Gryphon Mountain Tales may think this strange, seeing as I haven’t posted a new tale in months. I did promise an experiment, and the experiment proved that I’m not good at serial fiction. I don’t do well when I have defined only a vague overarching storyline. I’m not saying that the Tales have died; they’ve just taken a big break.

Focusing on a novel, not to mention trying to spend time with my daughter, has left much less time for blogging here than I’ve had before.

Second, I haven’t had as much to say about tech comm this year, or at least during the last several months. As I said, I think this is related to the first cause. My mind hasn’t been on tech comm as much as before, so I haven’t had as many ideas for blog posts.

I used to have this “blog lens” through which I would view much of my professional experience. Multiple times throughout the week, I would think, “That topic would make a good blog post,” and I’d make a note. However, in much of 2011, my subconscious has been working out kinks in my novel instead.

With all of that said, however, I do have something to blog about today. :)

Part of the User Education team’s goals in 2011 was to have a team style guide finalized. I became the driver behind that effort. Mainly because of that, and probably because I’ve been doing a lot of writing and revising, the topic of concise writing has been on my mind.

A lot of the problem with common English usage these days is the padding. People insert words that don’t need to be there. Our wording isn’t precise. People feel like they have to add modifiers to their words to add importance or clarity when they don’t need to, resulting in redundancy and the weakening of the core idea.

Writers know that putting together a concise, clear message takes time. But I believe the first try would be closer to the mark—not to mention the final version—if we truly understand the language and use words precisely.

I’m sure you’d like an example. I’ll give you a couple.

“Return again.” What’s wrong with this phrase? Nothing, if it’s used correctly. Return means to come or go to a place you’ve been before. If you’re talking about returning the first time, the word already includes the idea of “being there again.” If you then leave a second time and come back, you are then in fact returning again. But most of the time, when I hear or read the phrase “return again,” the speaker or writer isn’t talking about a second time coming back, but rather the first.

“Each one.” This phrase is redundant. Merriam-Webster’s even shows one of the definitions of “each” to be “each one,” drawing on one of the other meanings of “each.” But when people say or write “each one,” they’re generally using “each” in the sense where it can stand alone meaning “each one,” making that “one” unnecessary.

I’m getting dizzy going in circles like this.

Anyway, my point with this example is that I don’t know if there’s ever a reason to say “each one” in speaking or writing. “Each” suffices.

These examples illustrate how easy and common it is in English, and perhaps other languages, to tack unneeded words on to other words.

To be precise in our writing, we should understand these nuances and then write, and edit, for them.

For technical communicators, precise language isn’t about persnickety grammarians with yardsticks ready to rap knuckles. Precise language means clear communication, less content for our audiences to sift through, and lower translation costs (where every word is an expense to the organization).

Precision is concision.

Note: If you find any unnecessary words in my post, let me know. :)

Tags: , , , ,

The cost keeps going upI wonder if there’s a tech writer out there—in the software industry, anyway—who would argue that being involved in the design stages of a project is a bad thing.

This theme comes up time and again among our User Education team members. Yesterday, one of us gave a presentation to our community of practice about usable design, what makes something usable, and how tech writers can contribute. She suggested we come up with some metrics that help us demonstrate how our contribution to usable design increases user productivity and lowers cost.

As part of her illustration, she showed a chart about the more and more expensive it gets to fix a bug from the requirements stage through to the maintenance stage.

An idea came to mind, and I shared it with the team, that one of the things that we can use some hard numbers with is determining how many steps it takes to complete a task. The presenter had used an example to show how a process that she would have expected to take four steps instead took twelve. If we can analyze designs and determine how many steps it takes to complete associated tasks, we can tell the project team, “That’s going to be hard to explain. That process will take ten steps (or fourteen, or twenty). And when a user sees a procedure with that many steps, the first thought is ‘This is going to be hard,’ probably followed up with ‘I hope I do it right.’ Confidence goes into a nosedive.”

› Continue reading…

Tags: , , , ,

Over the last few months, the User Education Team has developed a content model and a supporting style guide. Our evaluation of various documentation authoring tools a few months ago resulted in our choosing Author-it—a tool none of us was familiar with.

In our discussions about our content model, or how our information is structured, sometimes we kept drifting into talking about what Author-it would allow us to do. It was an easy line to cross. The way you approach reuse and other considerations can change based on what tool you use.

But overall, the optimal way to structure information isn’t dependent on a tool. That’s probably why our team lead kept steering us away from thinking about whether aspects of our authoring approach and information architecture would be supported in Author-it. There were parts of our discussions that blurred the lines—we would sound like we were talking about the tool, but we really weren’t.

Such discussions highlight what I’ll refer to as the core component of technical communication.

That component is the heart of the term technical communication—that is, communication.

The secondary part of that term, technical, refers to the subject matter we are communicating about. But it could also refer to the method we choose to author, organize, and deliver the content, which these days rests in technology.

Technology changes. Communication channels and content delivery mechanisms change. We have Author-it today, but something more fitting for our organization and our needs may come along in a few years. DITA has spread through much of the tech comm space, but who’s to say something more effective won’t come along in the future, or that DITA won’t evolve (see what I did there) into something better?

Yes, the technology changes, but the core principles of communication don’t.

› Continue reading…

Tags: , , ,

Not that I’m the most stylish guy, but I’ve been working on a short style guide for our team. Our organization has a style guide that relies heavily on the Merriam-Webster dictionary and the Chicago Manual of Style, but it gives little attention to content regarding technology. To this point, the team has used the Microsoft style guide (third edition) as well, but it has some style specifications in it that seem pretty outdated—and rightly so, since it was published in 2003 or 2004.

The objective for our style guide is to highlight the most important considerations so they’re together in the same place. That way, when we have a new member of our team or another contributor, it’s not a huge chore to review the team style guide and get up to speed.

It was with this in the back of my mind that I went to the Society for Technical Communication’s (STC) yearly conference a couple of weeks ago. I attended some sessions that had to do with writing for localization and for accessibility. In her presentation, “DUH: Diverse. Understandable. Human,” Char James-Tanny talked about inclusion being a better word than accessibility. Her presentation came close to what I had begun thinking about.

› Continue reading…

Tags: , , , , , , ,

Sometimes I get ideas about a problem I’m trying to solve once I’ve stopped actively thinking about it and have let it drift into the back of my mind. With Project Pinnacle, something escaped my attention until a few weeks after my visit to the pilot site.

Well, it didn’t entirely escape my notice, but its implications for documentation and training didn’t hit me immediately.

The thing I noticed while watching users try out my quick reference guides was that they tended to follow only the first few steps of the procedure. They would look at it long enough to get to the screen where they performed the task, and then they would try to do the rest without the guides.

One of the reasons for this is that they had to keep glancing between the monitor and the paper, which made it easy to lose their place. Trying to use a finger didn’t help much either because at some point they had to start typing.

A few weeks after my visit, I got an idea of maybe a true quick reference guide that would fit what they needed. Since they relied on the printed procedures only for navigation, why not just provide the navigation steps?

I put together a version of each guide that listed the steps with double angle brackets between each step. This condensed the existing material from about four pages for each guide down to under one page. I haven’t tried these versions out yet. The project manager wasn’t in favor of the version of the guides that have the screenshots with callouts because of the cost of keeping the screenshots current for all languages.

When I first reported to the project leadership about my visit to the pilot site, I pointed out that a way to improve our training of our audience and at the same time reduce documentation costs would be to provide more prompts in the application. I’m not trying to reduce my workload, but I believe that the more help you provide in the interface, the less help you have to maintain elsewhere. I know, not real profound, but it’s not something very many product designers think about.

Since then, I’ve provided prompts and descriptions for a number of application screens and features. We’ve seen a direct impact of this as we’ve worked on the training video scripts. We want to keep the verbal explanations simple and let the features be demonstrated so that we don’t have to rerecord the audio if features change. The fact that we’re including help in the interface helps us do this because we can leave much of the explanation to the application itself.


Image credit: Salvatore Vuono, freedigitalphotos.net

Tags: , , ,

Last week I visited the pilot location for Project Pinnacle. My focus was to see how well my first-draft quick reference guides worked, but I spent some time training.

The office staff tended to want to ask me how to do things and be walked through it, but I took those times to ask them to test out the instructions for me. However, on one occasion, I had to guide a brand-new user through a somewhat complicated scheduling procedure while she was on the phone with the person setting up the appointment. I figured it would be better to help her through that one because she’d feel enough pressure from trying to do it right and in a timely manner.

In addition to notes on improvements to make to the guides, I kept other notes. The rundown:

  • 5 tasks to add to the guides
  • 14 other changes needed to the guides
  • 20 feature or change requests
  • 10 bugs
  • 14 miscellaneous items that were questions, observations, or usability problems

› Continue reading…

Tags: , , , , ,

I’ve been reading Ginny Redish’s book, Letting Go of the Words: Writing Web Content That Works. It was a bit slow at first because the early material is pretty basic. And I came into it with the preconception that it wouldn’t apply much to documentation, since we write help systems and manuals.

In light of our team’s search for the tool that best meets a set of specific requirements, I’ve decided that Redish’s book has everything to do with what I do—or what I should be doing.

My Beef with Tri-pane Help

If you’ve been reading this blog for a while, it’s no secret to you that I’m not a big fan of tri-pane help. I think it’s dated and is associated in people’s minds with unhelpfulness.

But in our search for a tool that will give us a more robust Web output, I’ve discovered the main reason I don’t like tri-pane help.

› Continue reading…

Tags: , , , , , , ,

In our quest to get more decision-making weight in the organization, the User Education team is putting together a set of standard practices. You may wonder why we don’t already have these. To put it succinctly, we still have to carve out our place in the IT department’s project lifecycle so that at least most projects have a user education component to them. Since there have been only a few of us, we’ve operated mostly by our own judgment, each person doing what he judged appropriate for each project.

We’ve come to realize that if we want our department to take us seriously and give us the place we want, we need to be equipped to justify the decisions we make on what user education products are right for any given project. One of the things I’d like to see happen in our team is to develop a menu of products, each with a specific definition and an explanation of the situation(s) in which we would recommend that product.

I’ve taken a first shot at this. I’d like your help to flesh this list out, the descriptions, and the reasons you’d use each one. In the comments, please let me know what I’ve left out.

Quick Reference Guide: One-to-eight-page guide that contains reference information, repeatable tasks, or some combination of these. Used when users have small number of tasks or will frequently need to refer to charts, tabular data, and so on.

Quick-Start Guide: One or two sheets that explain the steps for setting something up. Could also provide a set of most common tasks. A throw-away document. Focus may lean toward one-time training.

Short Guide: Thirty-to-forty-page document that provides task steps and reference information. Used when there is too much information for a quick reference guide.

› Continue reading…

Tags: , , , , , , ,

No Silver Bullets in Tech Comm Technology

Silver bulletWhen I was in elementary school, I learned that it’s pretty much guaranteed that when answering true-and-false questions, if the statement contains any absolutes, it’s false. Notice I hedged there a bit.

The same thing is true when we’re talking about tools and technology in technical communication.

I see blog or Twitter posts sometimes that insist that some approach is the key or the only way to go. Sometimes, such statements are true—if they support such timeless principles as knowing your audience. But when they set forth some technology or technology-based approach to communication as the silver bullet that will solve all your tech-doc woes, I don’t buy it.

› Continue reading…

Tags: , , ,

A Built-in Method of Delivering User Assistance

I have a crackpot idea for presenting user assistance in software or on websites. Okay, maybe it’s not so far out there, but I haven’t seen this done anywhere that I can recall.

Like a lot of ideas, I was probably thinking about something else when this occurred to me. But I’ve got this picture of a div that slides or pops out in the interface when the user wants to see it to get more information. This pane could appear to one side or the bottom of the main section of the page.

Here are a couple of mockups. These are not to scale.

Help opening at the side
Help appearing to one side

Help opening at the bottom
Help appearing at the bottom

The advantages of this approach is that the user doesn’t have to see help unless he or she wants to, and it’s right there in the same window, not covering up anything, so you don’t have to switch back and forth between windows.

Disadvantages are the limited real estate for content and the amount that this may cut into the site or application’s usable space.

One of the main things I like about an approach like this is that I believe user assistance ought to be designed into the interface. It shouldn’t be something added at the last minute like you were deciding what hat to wear today before leaving the house. It’s part of the user experience, so it should be part of the user experience design—with input from the technical communicator, of course.

What do you think? Have you seen this kind of approach anywhere?

Tags: , , , , , ,
« Previous posts Back to top