Categories
Business Process Tools Uncategorized Writing

Why Bother Writing Requirements?

We’ve recently been approached by two different companies about writing requirements. The first, a small company, wanted to develop a dashboard to replace a third-party application it was using. The owner, who had most of the information in his head regarding what the new dashboard should look like, what it should do, etc., suggested we send one of our writers to his location to study the existing dashboard, spend a little time with him and some of his key people to learn more about the functionality the dashboard needed to support, and “capture” this information so he could give the requirements to a developer or offshore the project.

Categories
Business Uncategorized Writing

RFP Responses Go Technical

With the tightening economy and more competition, more and more companies are relying on the RFP (request for proposal) process to find the best vendors/products.  This process often involves a team effort with members of product development, finance, and marketing (to name a few of the most common groups) involved in drafting a response.  We’ve worked with several companies recently helping them respond to RFPs and wanted to share our findings on the matter.

Categories
Business Uncategorized Writing

Technical Writers Need Coaches?

In a recent issue of the New Yorker, Atul Gawande argues quite persuasively that like participants in sports, surgeons (like himself) can benefit from coaches.  Even the elite stars, like Rafael Nadal, he points out, have coaches, observing, watching every move of the tennis great.  Why, he wonders, don’t doctors – even senior, experienced ones – have coaches?  As he says, “”I’d paid to have a kid just out of college look at my [tennis] serve.  So why did I find it inconceivable to pay someone to come into my operating room and coach me on my surgical technique?”

Categories
Business E-mail Language Process Tools Training Uncategorized Writing

How Documentation Can Create Trust

When you are a company dealing with your customers’ most valuable personal information, you need them to trust you. One easy way to do this is to have your documentation flawless (or close to it). Also, performing a test run with a small group of people before releasing it to the masses is a good idea. The group of people should be 3rd party users who can find the mistakes you can’t find (since you’ve read and reread the form 40 times and never want to see it again).

Categories
Process Tools Training Uncategorized Visual Aids Writing

Reading Images

There is an unfortunate trend towards using more images and icons and using fewer written instructions (I like to say “words”). Personally, I don’t think it’s obvious what every icon actually is and what it means, especially when I’m in a hurry to do something.

Categories
Business ROI Screencasting Training Uncategorized Writing

Showing Returns on Your Documentation Investment

Hello again readers!  Last time we “met,” I had the pleasure of walking you through a quick primer on the Kirkpatrick model and how to best use it to assess the effectiveness of a given training program or set of training materials. My main argument was – whatever you do – make sure to focus on metrics that allow you to show measurable positive impacts that can be easily translated into $ savings. The bottom line is… well, that’s what your manager will be looking at, the bottom line. What’s the return on this documentation investment? At the end of the day, how many dollars does it put back in our pocket?

Categories
Business Process Tools Training Uncategorized Useful Links Visual Aids Writing

Do you know about Document Map in Microsoft Word?

Whenever I go through a Word document with clients and they ask where a section is, I always refer them to the Document Map. Frequently, they don’t know what it is. Do you know what it is?

In short, Document Map displays the table of contents on the left side of your screen. This is helpful when searching for sections in a document even if there is a table of contents (less back and forth). You just have to make sure your text has heading styles applied to it correctly.

To find it and use it, follow the steps below.

Categories
Language ROI Uncategorized Writing

What is Bad Spelling Costing You?

According to an article making the rounds last week from the good ol’ beeb: Spelling mistakes ‘cost millions’ in lost online sales:

He says he measured the revenue per visitor to the tightsplease.co.uk website and found that the revenue was twice as high after an error was corrected.

Categories
Language Uncategorized Writing

OMG WTF LOL

You know that obnoxiously trite line “The Oxford English Dictionary defines (fill in the blank with a simple word) as…”?  It just got a whole lot worse.

Recent additions to “the OED” (does everything need an acronym?) include LOL, ego-surf, and smack talk.  I gave the monitor the evil eye as I scrolled down the list of newly added and updated terms.  Now these words that will almost certainly fall out of style are cemented in our language (oed.com says that entries are never deleted).

What about this bothers me so much? 

Categories
Business Writing

Newsletter (Re)Designed

You’ve seen the email version of the inaugural edition of our monthly newsletter.  Now see the original pdf.

Newsletter pdf