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.

---

Google News Updated : Thu, 24 Jul 2008 06:51:44 GMT Favre's heir? With backing from mates, Rodgers waits patiently - USA Today Bleacher Report Favre's heir? With backing from mates, Rodgers waits patiently USA Today - 4 hours ago By Matt Ludtke, AP By Larry Weisman, USA TODAY He no longer sounds like a retired player after seemingly passing on the opportunity to lead a talent-laden Packers squad. Video: The Rift Between Favre and the Packers AssociatedPress Finding new home for Brett Favre won't be easy Chicago Tribune Minneapolis Star Tribune - Kansas City Star - The Canadian Press - Tampa Tribune all 512 news articles Publ.Date : Thu, 24 Jul 2008 02:06:18 GMT Zimbabwe Parties May Sign Unity Deal Soon, Business Day Reports - Bloomberg ABC News Zimbabwe Parties May Sign Unity Deal Soon, Business Day Reports Bloomberg - 28 minutes ago By Carli Lourens July 24 (Bloomberg) -- Zimbabwe's ruling and opposition parties may sign a power-sharing agreement soon as they have already agreed on a wide range of issues, Business Day reported, citing people it didn't identify. Fearsome Zimbabwe militias are afraid Los Angeles Times Delayed Zimbabwe Power-Sharing Talks Seen Beginning Thursday Voice of America BBC News - guardian.co.uk - AFP all 3,609 news articles Publ.Date : Thu, 24 Jul 2008 06:23:06 GMT Billionaires Back Antismoking Effort - New York Times Boston Globe Billionaires Back Antismoking Effort New York Times - 27 minutes ago Bill Gates and New York Mayor Michael R. Bloomberg announced their antismoking initiative on Wednesday in New York. By DONALD G. MCNEIL JR Bill Gates and Mayor Michael R. Bloomberg announced on Wednesday that they would spend $500 million to stop ... Video: Gates, Bloomberg Pool Riches to Fight Smoking AssociatedPress The $500 million war on smoking Minneapolis Star Tribune BusinessWeek - eFluxMedia - Bizjournals.com - FOXBusiness all 471 news articles Publ.Date : Thu, 24 Jul 2008 06:23:48 GMT Discovery may boost statin safety - BBC News InjuryBoard.com Discovery may boost statin safety BBC News - 7 hours ago Scientists have pinpointed a gene mutation as a major cause of a rare side effect of the cholesterol-lowering drugs statins. They hope the discovery could lead to a simple test to identify patients at increased risk of myopathy - severe muscle pain and ... Gene May Predict Cholesterol-Lowering Drug Risk, Study Says Bloomberg Genetic Cause of Statin-Related Muscle Pain Found Washington Post U.S. News & World Report - Reuters - The Associated Press - The Star-Ledger - NJ.com all 172 news articles Publ.Date : Wed, 23 Jul 2008 23:14:24 GMT Karadzic lived the good life with wine, song - Reuters ABC News Karadzic lived the good life with wine, song Reuters - 2 hours ago By Ivana Sekularac BELGRADE (Reuters) - Radovan Karadzic lived the good life while hiding from justice for 11 years: he watched his diet, fell in love and hung out in a small bar where hardliners gathered to sing about his wartime exploits. Video: Karadzic's arrest sparks clashes - 23 Jul 08 AlJazeeraEnglish Karadzic's secret life enthralls his fellow Serbs The Associated Press Reuters UK - euronews - New York Times - Voice of America all 5,771 news articles Publ.Date : Thu, 24 Jul 2008 04:05:33 GMT Christian Bale's lady sidekick: Sibi Bale - Los Angeles Times ABC News Christian Bale's lady sidekick: Sibi Bale Los Angeles Times - 4 hours ago Like the Dark Knight/Bruce Wayne, Christian Bale is a real-life man of mystery. Averse to personal publicity, he is well-known for not wanting to discuss his private life. Christian Bale, Wife "Solid" at Knight's Spain Premiere E! Online Bale's family feud led to scuffle The Star-Ledger - NJ.com People Magazine - New York Daily News - Boston Herald - Variety all 2,386 news articles Publ.Date : Thu, 24 Jul 2008 02:10:31 GMT Rapper 50 Cent sues Taco Bell over ad - New York Daily News ABC News Rapper 50 Cent sues Taco Bell over ad New York Daily News - 36 minutes ago BY THOMAS ZAMBITO The rapper - real name Curtis Jackson - is suing the fast-food chain for using his hip-hop persona to tout its tacos. 50 Cent sues Taco Bell over ad campaign The Associated Press Rapper 50 Cent says Taco Bell stole his endorsement Reuters E! Online - MTV.com - CNNMoney.com - KWCH all 187 news articles Publ.Date : Thu, 24 Jul 2008 06:15:09 GMT Blogging Software asdfasfd

PARLOT::Ebooks, Scripts, Websites, and more...

Adsense websites

Freelance Copywriting Advice #1: Take the Scary Jobs

From time to time you will be faced with an... Read More

Can Anyone Succeed as a Freelance Copywriter?

This is a question that can be answered in a... Read More

Do You Make These 5 Mistakes When Writing Sales Copy?

Writing copy has sometimes been compared to an "art." While... 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,... Read More

How to Write Ad Copy that Sells

When I write copy for my advertising clients, I always... Read More

On Copying and Stealing Designs

The notion on the great artist, Pablo Picasso's quote, "Bad... Read More

Power Keys To Writing Power-Packed Marketing Copy

In order to maximize your sales efforts and fully seize... Read More

10 Things You Should Expect From Your IT Copywriter

Anyone who's ever tried marketing IT products or... Read More

How to Develop a Killer News Hook

When you are going to write a press release probably... Read More

Art Of Writing Profitable Classified Ads

The art of writing profitable classified adsEverybody wants to make... Read More

Why Copywriting Is The Secret To Your Online Success

Over the last decade, the number of companies selling their... Read More

3 Tips For Writing Better Headlines

The single most important element of your website's copy is... Read More

Revealed: The $12,500 Copywriting Formula

Have you heard of Brian Keith Voiles? Probably not, but... Read More

Freelance Writers: Double Your Income

Freelance writers are a strange group of people when it... Read More

How to Write Carrot-Wielding Copy!

A significant reason behind websites that fail is the lack... Read More

Want a Sticky Site That Sells? Forget Content!

An interesting debate is currently raging among copywriters, web designers... Read More

Common Mistakes That Can Kill Your Web Copy

Sometimes learning what not to do is as important as... Read More

7 Easy Tips on How to Improve Your Sales Letter Instantly

Would you like to get more sales from your online... Read More

Does Your Copy Look Fake To the Search Engines?

From the early days of search engine optimization, keywords and... Read More

Is Your Web Copy Plain Talk?

It's true, we were all taught in school to express... Read More

So Youve Decided to Hire a Freelance Copywriter - A Guide to the Collaboration Process

Whether you're an executive or a small business owner, chances... Read More

16 Golden Rules of Master Copywriting

You could spend thousands of dollars on advertisement and have... Read More

How To Write Powerful Headlines

I want to tell you how I go about writing... Read More

Tomorrow?s Clichés Today

I went to Google and entered a couple of different... Read More

Copywriter Rates, Getting The Facts Beforehand

Have you ever had the experience of hiring a freelance... Read More