Home  /  Computers



  Print this article
  Email to friend
10 Tips for Tech-Writers
Author:

Tech-writing is a tricky business. It's not a very high profile industry, so there's not much support around. Follow these 10 quick tips, and you'll be well on your way to a satisfying tech-writing career.
1) Follow a sensible career path…


  • STEP 1: Start in a team
  • STEP 2: Stay only just long enough
  • STEP 3: Manage yourself
  • STEP 4: Manage a team
  • STEP 5: Go contracting (depends on the market)

2) Knowledge is your lifeblood – learn the politics of your company. Know who knows what. Find someone who consistently gives you timely, reliable, technically accurate answers, and get their name tattooed on your shoulder! Every company has at least one. And they may not be in the project manager/product manager/customer/programmer roles. They are generally the people who've used the product in the real world, and dealt with real world customers.
3) Communicate WITH, not AT. Tech-writers don't have enough power to get away with communicating at.
4) Track stuff (take spreadsheet printout and write it up on the board).
5) Develop good product and domain knowledge – The more you can figure out for yourself, the better off you'll be (and the more respect you'll get from the techies).
6) Find out who your users are, what they are trying to do, what they are having trouble doing, and how they want to be helped. Then provide this assistance. Help the user do what they are trying to do. Don't just tell them what the product can do… a help system is only helpful if it addresses the users' needs.
7) Treat everyone as a customer. Then manage their expectations and your commitments. Always ensure they know what you're doing. Tell them when

   ( Next Page )


Rate this article:  (No ratings yet)

 Saving ...

RECENT ARTICLES FROM COMPUTERS CATEGORY
Choosing the right printer ink (Author: Jeff Lakie)

In today's technology age, most homes or offices have computers with printers. With regular use, printer ink may begin to dwindle. You'll notice that your printouts begin to look faded or splotchy. Supplies ...


I-RAM, M-RAM: Good Bye to Hard Drives? (Author: Marcelo Reyes)

A couple of weeks ago, one of my lab associates made a comment about the advantages of the I-RAM and its speed with respect to the hard drive. What is an I-RAM? I asked. Simple. They are a bank of ...


Getting Back to Basics: Creating a Logo from Start to Finish (Author: Bernard Peh)

When I began my career in the graphics industry, almost 17 years ago, I would approach the design of any new logo by first taking out a pad of paper and a pencil and sketching out basic ideas before ...


Cabling Your Home for Computer Network - Still a Requirement? (Author: Dmitriy Abaimov)

With proliferation of wireless networking and communication equipment it is oh-so-tempting to cut the cord and save a significant sum of money in the process. But is everything that a regular computer ...


Accounts Payable: A Powerful Document Management and Workflow Solution (Author: David Coxell)

Accounts payable is just one area of office management where problems arise because of the sheer complexity of transactions, and the vast amount of paperwork that is generated.A disproportionate ...


SEARCH
Search for:


In:


NEWSLETTER
E-mail address:


Name:


Copyright ©2007 HyperArticles.com. All Rights Reserved. - Privacy Policy - Disclaimer