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.
Related News
“How to Explode Your Website’s Marketing Potential With A Few Easy ... - NewsReleaseWire.com (press release)
10 ADVERTISING WORDS TO AVOID IN 2009 - Gather.com
10 ADVERTISING WORDS TO AVOID IN 2009Gather.com, MA -Dec 31, 2008In 2009, perhaps more than ever, the words you use in your copywriting can determine whether you make a sale or lose a customer. Here are 10 words to avoid ... |
North Carolina Freelance Content Copywriter Jason Pedley Announces ... - dBusinessNews Triangle (press release)
The Ultimate Web Copywriting Secret - PWO
The Ultimate Web Copywriting SecretPWO, France -Dec 28, 2008And it is often so obvious, many copywriters forget about it. Or ignore it. Or do not pay enough attention to it. No, it's not having great bonuses. ... |
Web Writing: The Good, Bad and Ugly - CMSWire
Web Writing: The Good, Bad and UglyCMSWire, CA -7 hours agoWeb copywriting would be easy if your prospects and customers thought the way you do. But they don’t. Consumers are not necessarily interested in your ... |
The Copywriter's Secret Weapon Against Readers' Fear - PWO
eWriting Café Announces the Launch of New Website - PR.com (press release)
Copywriting for Direct Mail - Part 3: Five Motivators - Web Host Industry Review
Weekly Web Tip #7 - Stop Hemorrhaging Leads & Sales - Furniture World Magazine (press release)
Zuula Consulting is the New Face of Communication - PR Newswire (press release)
|
|
 |
|
|
RELATED ARTICLES
5 Critical Mistakes Most Freelance Copywriters Make
Think you have what it takes to be a freelance copywriter? I wasn't so sure I knew when I first started in 1999. All I knew was I desperately wanted to work from home to raise my two sons after my divorce. It took a lot of trial and error to get to the stabile and profitable business I am running now in 2005. There are some things I learned along the way I wish I knew much earlier in the game.
Fill Your Readers with Confidence
Site visitors generally stay with you for as long as they feel confident that they will succeed in achieving their goal.
Discover Your Creativity
You have a choice. Do you want to be constructive and positive in a unique way? Or do you want to be destructive and negative in a unique way? History has proven the futility of the latter goal. So let's focus on your unique capacity to better yourself and those around you.
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 are you will have to hire a writer somewhere along the line to create your marketing material. Here is some insight into the process, what is expected of you, and how to get the most out of your investment.
Crank Out More Articles More Often With An Article Swipe File
If you write copy you need a swipe file. A good swipe file can save you lot's of work and enable you to crank out more articles more often
8 Tips for Writing Headlines that Grab Attention (and Keep Prospects Reading!)
Effective headlines make all the difference in whether your prospect reads your marketing materials or simply tosses them to the side. You don't even have a chance for a sale if the audience won't read what you write. One way to keep prospects reading is to give your copy attention-grabbing headlines. Here are eight tips to make sure your headlines get the message across:
Revealed: The $12,500 Copywriting Formula
Have you heard of Brian Keith Voiles? Probably not, but if you have eyes you've seen his ad campaigns and you probably even bought products that he created ad campaigns for. Would you like to have the formula he gets paid $12,500 to put into use for Fortune 500 Companies?
Creative Copywriting?
There is a difference between creative writing and copywriting. It took me a while to come to terms with this but it's true, there is a difference. When I first started my home based business on the Internet I read a lot of advice about publishing articles and doing copywriting to advertise your website. There was always a distinction drawn between copywriting and creative writing. I did not understand this: surely copywriting is creative? Eventually the logic dawned on me: all copywriting is creative writing but not all creative writers can write decent ad copy. If you have never studied that particular branch of philosophy, it's like all roses are flowers but not all flowers are roses.
Business Writing: When Not To Be Professional
It's time to write your next ad or brochure. Maybe some web content. You've done all your research, and you're staring at a blank computer screen. You want to look good in print. You want to put your "best foot forward." And, of course, you want to make a barrel full of money.
How To Get Started With A Career In Copywriting
Careers in copywriting are booming. Could it be that the new and ever growing market on the Internet has helped to fuel this demand? You can bet your sweet keyword that it has! With so many businesses looking to the internet for their freelance copywriters the demand for employees keeps growing. Likewise, careers in copy writing are being filled more and more with freelance or independent workers. Even those who work right from their home are jumping onto the bandwagon. But, copywriting careers are not all fun and games.
Can Honest Copywriting Succeed?
I confess--I'm a marketing heretic! I've built my career on breaking all the
rules--and one of the rules I break is that I don't hype.
The Five Rules Of Influential Web Writing
Building a professional reputation requires a campaign founded on your words: the positions you endorse, the motions you advocate, the accuracy of your vision. Writing for the Web can either establish your expert credibility or destroy it.
Tomorrow?s Clichs Today
I went to Google and entered a couple of different search terms.
Copywriting Makeover: Making An Emotional Connection - Part 2 of 2
In part one of this article series we began looking at the Cruise Vacation Center site: a travel site whose copy was sorely lacking in emotional appeal and visual imagry. (You can see the previous version of the copy here: http://www.copywritingcourse.com/CruiseVacationCenter-Original.pdf.) In the conclusion, youll see how all the rewrite turned out and how exciting the end results have been.
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. While it might sound frightening or frustrating, it's a fact of copywriting life. So what do you do next? Give up? What difference does it make if only about 20% will be read anyway?
3 Ways to Increase Conversion Rates
In a previous article I talked about a few similarities between writing direct mail packages and writing web sites. In short, I concluded that as online writers we could learn a lot from direct marketers.
Copywriter Trick Unveiled: How to Write Better Copy Faster
"Talent alone cannot make a writer. There must be a man behind the book." Ralph Waldo Emerson's Goethe
Sales Headline Copywriting ? Two Quick Steps to Success
Get a Good Start for Sales Success
11 Things You MUST Know Before Hiring a Copywriter!
If you're considering hiring copywriting help for your next brochure, Web site, or marketing project. Congratulations! You should get great results if you hire a pro to do it right.
Copywriting for Astrology, Numerology, Tarot, and the Mystic Audience
These days, you don't have to traverse the dark forest on the eve of the Full Moon to find a gypsy, psychic or "intuitive" as many now call themselves. Chances are, the local astrologist or tarot reader is making more than a comfortable living for herself in a corporate complex near you. She's probably dressed in proper business attire, scheduling consultations from her art-deco office right now.
|