Technical Writing Tips

By Tom DuVall

Technical writing is much harder than any other form of writing and it’s a good idea to get all the help you can get. Start here with some of these helpful tips that we’ve put together to help ensure that your technical writing piece is a success.

Consistency

Wording is of essential importance in technical writing. This is not a creative writing piece where it’s encouraged that you utilize action verbs and colorful adjectives and imagistic metaphors. In fact, in technical writing the goal is the exact opposite. Your goal is stripped down writing with descriptions that are as bare and simple as possible.

With some things in technical writing, however, it isn’t possible. When you’re writing about technical things, using technical terms is part of the package. Hence the name. What you don’t want to do is refer to this technical part or software or process or research with more than one term. Pick one and use it through out. If necessary, include a glossary with the article for ease of translation. Otherwise, define it the first time you use it and repeat the exact same term throughout when referring back to it.

For example, feasibility reports are also called evaluation reports. But when you are writing about it, you may mention that one term can be replaced with the other when you define it, but you need to pick one and use it consistently throughout.

The Voice of the Consumer

As the technical writer, you don’t have to take this task on, but it will be beneficial to everyone down the road if you do. As the link between the engineer and the lay user, you have a bit more knowledge about technical terms and how to apply them to make things work. This means that if you can’t understand how to use whatever you’re writing about or understand why anyone would, don’t suck it up. Explain to the engineer, scientist, or computer programmer what difficulties you are having. If you don’t get it, it’s not likely that your reader will either. Eventually, whoever you are writing for will end up back at the drawing board anyway to update the product, so you’re really doing everyone a favor by voicing your concerns.

There are a few ways to make this easier on you as nobody wants to hear that their product (or whatever your technical writing assignment is based on) is defective in any way. First of all, the earlier and more involved with the project, the better. If you’re invisible and then all of the sudden pop up with comments, even if they’re valid, they will probably be ignored.

Next, do your research. Know what you’re talking about and have suggestions. Know the language and a little bit of the history of the project. If you come off like you have no idea about anything at all, the only thing you will call into question is your ability to be their technical writer.

Also, if you do come up with ideas for how to fix the problems, make sure they are reasonable. Small companies with minimal funds barely have enough money to pay you. If you suggest outlandishly broad testing or upgrades and implementations that are going to set the project back indefinitely and they decide to go with it, you may be out of job. Technical writing is your bread and butter. If there’s nothing to write about, you’re in trouble. Concern for humanity is a good thing, but it’s smart to pay your rent, too, so if you do come up with specific ideas, keep it simple and realistic.

Necessary Background

When it comes to research, there’s no such thing as too much. At least, as far as your own personal knowledge is concerned. As long as you know how to filter this information into a concise document, it’s a great idea. Too little information, and you could miss some really valuable aspects and implications of your technical writing topic. Really good technical writing is comprehensive and painless. Use a backlog of research to make that happen for your readers.

-

For pricing details, click here.

To inquire about our technical writing service, call
1-800-WRITE90 (1-800-974-8390) or e-mail copy@pegr.com.

This article is available for reproduction under the condition that it is accompanied by a link to http://www.pegr.com/technicalwriting.html directly below the title of the article with "technical writing services" as the link text.

Return To Homepage

Contact Us

To Discuss An Order