-->

Type something and hit enter

On
advertise here

 

Tips for Tech-Writers

Tech writing is a tricky business. It's not a very well-known industry, so it doesn't have much support. By following these 10 simple tips, you can have a satisfying career as a technical writer.

1) Follow a wise career path...

STEP 1:

Start with a team

STEP 2:

Stay long enough

STEP 3:

Manage yourself

STEP 4:

Manage a team

STEP 5:

Go Contracting (depending on market)

2) Knowledge is your lifeblood – learn your company's policies. Know who knows what. Find someone who consistently provides timely, reliable, and technically accurate answers, and have their name tattooed on your shoulder! Every company should have at least one There is They may also not be in the project manager, product manager, customer, or programmer roles. These are generally people who have used the product in the real world and have dealt with real customers.

3) Talk to MIT instead of AT. Technical editors don't have the power to escape communication.

4) Keep track of things (take printouts from the table and write them down on the blackboard).

5) Develop good product and subject knowledge – the more you understand yourself, the better you'll do (and the more respect your technicians will give you).

6) Find out who the users are, what they are doing, what their problems are, and how you can help them. Then provide this assistance. Allow the user to do what they are trying to do. Don't just tell us what your product can do... A help system is only useful if it addresses your needs.

7) Treat everyone as a customer. Then manage their expectations and your commitments. Make sure they always know what you are doing. Please let me know when you're done. And pull out all stops to meet your deadline.

8) Provide a surrogate user testing mechanism for the development team – providing usability feedback.

9) Work as hard as required to get good quality doco finished on time and to budget – this is how you'll get the satisfaction out of work that you need.

10) Have fun with it.

Don't become jaded and cynical by the high-tech, harsh, uncaring IT world. Use your intellect and make the most of the resources provided. Above all, make job satisfaction your number one goal. The best way to stay happy and move forward.

Click to comment