Friday, August 22, 2008

Judging a Technical Writer



I have been honored to know couple of tech writers personally, who are not only brilliant in their profession but are well-cultured human beings. Thus this sought them with well earned respect from every walk of life. How do you judge a technical writer?

Obviously,writing is the first criterion, which would stand out. When you say about good writing, what generally you analyze? I won't take names here, but good writers have an immaculate hold over their language. Thus when they are writing its all about the flow; they do not find it a hard terrain. These writers are inquizitive to the core.

Everthing surprises them and they seek for more. Lets talk about a writer in a health domain who suddenly got a freelance offer. The writer has to document on Mobile Technology. I tell you these writers would have googled and gathered enough information before they appear in an interview.

They don't see it as just another work, but the sheer pleasure of documenting a software product/ technology is more than a few dollars to them. These writers believe that if they can make a novice user understand the complexities of the product, they have done a great job.

Lets face the fact: Good writers are seldom available. So, when you catch one, try to sit and learn. I had been horrible in my prime of career (I guess am little better) but thankfully, I had a senior writer helping me out. He has been a learning experience to me.

After observing me for couple of days, he took me aside one fine day and gave me certain tips. He didn't ask me to change my writing style since he believed it was good, but he found it unsuitable for Technical Writing. He told me to go through a few of the documentation guides that he had delivered.

I went through and then he asked me to analyze with my documentation. I was at sea. The first noticeable feature of his writing was clarity. Good writers write in a very clear and simple language and even though it is complex, you'll find each and every line clear.

Gathering Information is the most essential factor in Technical Writing. Belive me as good writers will tell you,"if you can gather information well, 70% of your job is done. Poor documentation happens due to lack of proper information.

" I used to accompany with my seniors when they used to interview the developers and SMEs and the way they gathered information was so immaculate.

How to have a good technical writer placed in your company? Fortunately or unfortunately, there are no tools by which you can find out.

But, I guess you need to hire someone who has an interest in technology, someone who has a knack for learning tools and domain. Prepare a questionnaire where you can feature questions on Grammar as well as Technology.

I asked once someone to write the steps for preparing a cup of coffee. She couldn't write it properly. How on the earth could I expect her to write on something on Technology?