Six Reasons You Don?t Need a Technical Writer (and Why They?re Dead Wrong!)

I know, I know. Times are tough. You have to make due with the staff you have. It's a common and valid lament in today's workplace. You've got to do more with less, so an obvious place to cut costs is in your documentation efforts. After all, writers and editors are a luxury in lean times. You're a small company and you can produce your documentation in-house, right? Think again. Hiring the right freelancer to do the job correctly the first time around could save you hundreds or thousands in help desk calls, service calls, document revision, and distribution. Here's why.

1. You want someone with your industry or product knowledge. Knowledge of your industry or product is helpful, but your writer's ability to communicate well both in writing and in the spoken word is crucial to your documentation project's success. A good technical writer:

• designs easy-to-use and easy-to-find documents.
• writes clear and easy-to-follow instructions.
• demonstrates a broad range of technical knowledge which enables him or her to acquire new technical knowledge quickly. Most tech writers thrive on learning obscure technical facts just as much as they love discussing the merits of the semicolon. The best tech writers are amazingly quick studies.
• creates document templates with a clean, professional appearance that your company can re-use.
• asks intelligent questions of your SMEs (subject matter experts) that you might not think to ask, ensuring thorough coverage of the product's features.

2. The programmers or engineers can write the documentation. Oh, really? They're not busy enough already? Most programmers and engineers with whom I've worked loathe writing. Let them do what they do best and let a writer do what she does best.

Good technical writers are power users of most word processing programs, HATs (help authoring tools), and are privy to the latest documentation techniques that will enhance your company's professional reputation. A good technical writer is savvy about design trends and best practices. Can you say this for your engineers and programmers?

3. You need a writer on site. Why? This is 2005. Most freelance tech writers have high-speed internet connections, fax machines, and cell phones. I've worked with clients I've never even met or who I've met just a couple of times for documentation review meetings. It's good for the writer and it's good for you when you don't have an extra body taking up your valuable space. I have developed some of my best professional relationships in cyberspace.

4. Only you understand your users' needs best. Yes, you do. You know what they want and what they need; that's why your business is so successful. Consider the following questions:

• Does your documentation need to be geared to the newbie user or the experienced techno-geek?
• Do you know how to analyze your audience and write to that audience?
• Do you understand your audience's basic learning style?
• Will graphics work better than words to convey your message?
Will a CD or HTML-based online help work better than print documentation?
• How will you deliver and distribute the final documentation product?

A good technical writer will perform a user need analysis and provide a documentation plan that drives your information architecture design. She will create a documentation plan that will evolve over the course of the project and will allow the documentation to grow as your product changes. With a great foundation, you won't have to reinvent the wheel with every new iteration of your product.

5. You already know how to use MS Word. That's great and it's important.

• Are you thorougly comfortable with Word's advanced features?
• Do you dream in macros?
• Are you familiar with FrameMaker (a highly un-user-friendly but powerful favorite tool of tech writers that handles large, complex documents that make MS Word quiver and crash)?
• Have you ever designed online help using RoboHelp?
• How are your Photoshop, Illustrator, Paint Shop Pro, Quark, Visio, InDesign, and basic HTML coding skills?
• Are you aware of the latest trends in writing and grammar style so your company's message will be consistent and grammatically correct?

Good tech writers bring an extensive working knowledge of a plethora of word processing and graphics programs as well as standard business writing practices.

6. You can keep up with document updates.

• What is your plan for documentation version control?
• Who will write the updates?
• How will you ensure your users have the latest and greatest version?

If you don't have a version and source control system in place, multiple versions of your document in several folders create an organizational nightmare when it's time to revise or update.

There's a trend toward single sourcing technical documentation these days. Simply put, this means one source for all of your documentation needs. This single source may contain material for your print manuals, online help, and training materials all in one place. In single sourcing, a writer tags specific material for a specific use. When you deliver documentation, you simply designate the type of documentation you want (e.g., print, online help, user guide, training material, technical reference information) to create and the software does the rest. The point is, everything is in one place, making version and source control simple. Setting up a single sourcing system now will save you time and future headaches later. A good technical writer is familiar with industry trends for single sourcing and may be able to help you set up a single sourced system within your organization.

If you're skeptical about hiring a technical writer, consider this. Good written communication skills will always be in demand in the business world. However, in today's complex business world, just being a good writer isn't enough. A good technical writer needs technical savvy, a sound knowledge of dozens of software programs, and impeccable research and writing skills.

Would you hire an accountant to develop software? Would you want an engineer to answer phones? Would you expect a copywriter to do your taxes? Probably not. So, give your business and your wonderful products the professional attention they deserve and consider a technical writer for your next documentation project.

Copyright 2005 Ann Zuccardy. All rights reserved.

Ann Zuccardy is a freelance technical and copy writer with 17 years of industry experience in marketing and technical communication. She currently consults with IBM in Essex Junction, Vermont where she writes software user manuals, training guides, and release notes. Ann is also the owner of Vermont Shortbread Company. She can be reached at Wordbrains.com.

---

Does Your Copy Look Fake To the Search Engines?

From the early days of search engine optimization, keywords and content have always been vital to achieving your goals. Starting back in the days when we used... Read More

Getting Paid for Your Articles

If you've been writing web articles to help promote your business, you may also wonder if you can write articles and get paid for it. What type... Read More

The Secret to Web Copywriting Gurudom

Have you seen those copywriting gurus, working it on the web? How'd they get so darned famous? How can YOU get what THEY have? Here are some... Read More

How To Test The Body Of Your Sales Copy For Weaknesses

Your sales copy is the life source of your business. If your sales copy isn't pulling in a decent conservation rate, then your business is suffering.In this... Read More

Are Long Copy Salesletters Scams?

A passionate debate is currently raging in the Copywriters Forum about long versus short copy. (If you haven't joined, do so. Click the "register" link the top.... Read More

Is Your Web Copy Plain Talk?

It's true, we were all taught in school to express ourselves differently on paper, than the way we speak. To follow rules of grammar, and inject an... Read More

Its the Headline, Stupid! - Writing Powerful Headlines

"It's the headline, stupid," is the sign that hangs over my computer screen. It reminds me that to write effective articles, press releases, sales letters--whatever I want... Read More

7 Powerful Sales Copy Writing Techniques!

Your sales letter is the most important component in your web site or marketing campaign. It will introduces your products or services to your visitors and how... Read More

How You Can Find Freelance Copy Editing Jobs

Even for those with the skills needed, finding copy editing jobs can seem next to impossible. The simple fact of the matter is, though, that through quality... Read More

3 Tips For Writing Content That Will Make You Sales

Content is king. Without content your website is an empty shell, a skeleton with no flesh, an empty vessel. Content can redeem the worst designed website. The... Read More

Long Copy vs. Short Copy? If You?re Still Debating This, You?re Missing The Point!

I've seen this ongoing debate debate jump up again recently in several Blogs and message boards and I can't help but laugh. It's not a new debate?... Read More

9 Tips for Great Design of Your Marketing Materials

1) Don't just hire a good designer. Hire someone who has had plenty of experience designing business collateral. Your designer needs to ask you the right questions... Read More

The One Word Every Prospect Craves

It's arguably the most important word in the copywriter's arsenal. It ranks right at the top with words like "free," "new" and "savings."I'm talking about "you.""You" is... Read More

11 Ways to Get an Editors Attention

I worked as a business magazine editor for about 20 years. During that time, thousands of news stories and press releases crossed my desk.How does an editor... Read More

10 Tips for Writing Effective Web Copy

On the Internet programmers and designers rule, not the writer. Yet words drive targeted traffic to your site, carry content, make the sale, convey marketing messages, persuade... Read More

Your Article Headlines will Make or Break Your Business

Most people with an online presence will have to regularly deal with the issue of coming up with an appropriate headline. The problem is that most people... Read More

Step One for Copywriters: Understand WHAT to Say

Find a passage of poorly written copy, and chances are you will have found a copywriter who never figured out what it was that he or she... Read More

How You Can Proofread Your Own Work

Putting out a high quality product is a given these days. With all the competition out there, you have to look great in every aspect. So proofreading... Read More

Five Sections of Your Copy Guaranteed To Get Read

Only about 20% of your copy is going to get read. The rest will simply be scanned. I'm sure you've heard the statistic before. It's nothing new.... Read More

The Second Most Important Element of Your Ad... after the Headline

Hi {FIRSTNAME Friend},Next time you're flicking through your local newspaper, take a good hard look at the ads. And notice how many of them give you a... Read More

Copywriting Makeover: Making An Emotional Connection - Part 1 of 2

One statistic shows that over 80% of all buying decisions are emotional. That means your copywriting should be, too. This is something I firmly believe in and... Read More

How To Really Connect With Your Customer In Your Copywriting

One of the least talked-about areas in copywriting education is voice. This is probably because it's tough to set general rules for something that's so personal to... Read More

Killer Ad Copy

Not everyone is a writer. Good copy writing is a science and can be learned over time. Great copy writing is an art and should problably remain... Read More

Freelancers Can Jump-Start Your Publicity Initiative

If you find that your progress is blocked by a lack of time or experience, consider hiring a freelancer to jumpstart your project.Writer's block got you down?... Read More

Designing for a Non-English Audience

Having worked as a digital publishing specialist at a large corporation at my previous job, I did not think being in charge of foreign language typesetting would... Read More

Ad Copy - Your 12 Point Inspection!

You're ready to launch that new product or promotion, & you're really counting on a piece of advertising copy to come through for you.You're looking for stellar... Read More