1%

Points to Remember II


Technical Writer as Beta Tester

The technical writer is often the first non-expert to learn to operate a new technology, and has the opportunity to spot bugs or glitches and bring them to the design team's attention before the production process goes further. Pay attention when something doesn't seem to work as it should. Bring it to the attention of your supervisor, or call in the S.M.E. You may find out that you aren't using the technology properly. This can be valuable information (if a little embarrassing to obtain) because if you are confused here, your user may be also. On the other hand, you may have spotted a bug that no one knew about. Bringing it to the attention of the rest of the team can mean getting it fixed before the product gets into the customers' hands.


Technical writers can also evaluate the product's interface with the user. Are the controls on a piece of equipment easy to find? Is the equipment comfortable to use? How smooth is the operation of a software interface? How many clicks does it take to get something done? Does any process seem too cumbersome? Bringing usability issues to the attention of the design team, if done with sensitivity and an open mind (no one LIKES criticism, so be fair), can improve the product. Ideally a technical writer will not focus strictly on writing a help manual but will participate in the development of a new product and will provide a perspective closer to that of the intended end user.

New Technology, Don't be a Witch Hunter

At the same time, the wise technical writer doesn't make it their mission to spot bugs. Don't ignore one if you find it, but don't approach a piece of equipment with the intention of finding out what's wrong with it. You may end up wasting time as well as alienating your coworkers. Assume that everyone wants the product to succeed, and that competent people have done their best to design it as well as possible given time and financial constraints. If you cannot believe this about the company and the product, this is a sign that you might want to look for another job.

]]>