Technical Writers Training

The profession of technical writing is no more an isolated domain of west. The past decades have ushered the emerging numbers of technical writers in India too. To those who have not come across this profession or this opportunity, technical writing is the art and science of writing about the technical subjects to help end users of the technology.

Most often the requirement of becoming a technical writers demands advanced knowledge of English writing. In fact the good knowledge of English writing holds good to comprehend complex technical knowledge into simple English writing that helps user to understand the technology. But don’t get misguided that to be a technical writer you need to have prior experience of journalism or mass communication or a post graduate degree in English. If you have flare for writing in English and if you can write simple and crisp English, you are in the league. However, if you are transitioning from Journalism or have a post graduate degree in English, you will have an edge. Yet again, I would say that writing is more of an art than science and it can be anyone’s passion.

Today, the opportunity in the market requires you to be good in English. Many companies would prefer you to be on-board and train you in the technical writing on job. Most others would like to have a person who has some exposure of technical writing and knowledge of styles and tools of the trade.

The technical writing training offered by different institutes in different parts of the country exposes you on the knowledge of the following:

• Different style guides of technical writing
• User guide authoring and publishing tools
• Help authoring and editing tools
• Image editing and designing tools
• Classroom sessions on procedure and instruction writing
• A glimpse of different kinds of documents written by a technical writer
• The different technological domain in which technical writers are getting employed
• Creating a sample documents  

The training institutes are meant to teach technical writing and not English writing. You will be disappointed if you think that they can teach you technical writing without you knowing English writing. However, you can complement your average level of writing skills with the expert level of authoring tool knowledge which often required in trouble shooting and that makes you a production specialist.

If you have good skills of writing and preliminary knowledge of authoring tool, getting a job as a technical writer will not be tough. Today, almost all the industry driven by technology requires technical writers into their fold. Being a trained technical writer would greatly enhance your chances of getting a job.

Technical Writer as a User

The name technical writer suggests about a person who writes the technical documents for the user, which helps them using the product. More often than not, when the user struggles to find out the answers of their problem in using the product, they seek the help from the support group. Obviously, users don’t find the answer of their problems in the documents, which were shipped to them along with the product.

The standard procedure followed to analyse the user’s problem and leading them to learn the product to use are not based on the realistic approach. Neither feedback system revamps the standard procedure in the next revision of the documents. The revision only includes the recent addition in the features and functionality. But most of the time even users also do not like to send their feedback on the documents. May be because of the perceived idea that their feedback will not be taken care or the life cycle of the product is so short that they understand that revamps are not possible.

In any case, it does not help documentation to improve. Therefore, sometimes technical writers, who are to be blamed for the sub-standard documentation, finds even user responsible for this cause. In a normal scenario, a technical writer assumes to be a user and interprets the knowledge transfer in a best suitable way they can. But, that may not be the simple way of translating the knowledge what user would have liked to be. I really bet, the understanding level and approach of different users differ immensely. That is how, even the understanding and use of an authoring tool widely differs among the technical writers too. Some are easily able to use the tool, whereas some takes time to learn and use.

I can understand that each one of us has different learning curves and that reflects while even using an authoring tool. Nevertheless, when a technical writer struggles to learn the tool using the Help or the User manual and finds it tough to get their answers, even then they would not like to send the feedback to the corresponding writers group. If they do so, hopefully, it might help improve adding those points in the next version of the product that could help another writer avoid rigors of tough learning.

Ideally, it could be better to list down the questions, which could be included in the User Manual or in the Help and send across to the product company as feedback. And I suppose during the next version as an update even these new answers could feature into the document. Therefore, as a user, it’s a best way to help our fellow writers and help improve even the documentation on the community level. Otherwise, we will continue writing the documents as we usually do and get overwhelmed thinking that we have produced the best. But, in reality, we will not be serving the user, for which we are paid for. Its time we don the role of a writer when we are writing the manual and take the role of a user when we use a product. At the end of the day we should not forget to send and receive feedback which would lead us to help and get help on our documents.

Technical Writers: Can you justify your job?

Technical writers are in the profession of disseminating the technical knowledge in structured format for the consumption of the user, which is aimed to realize a specific task or use. The present situation is, where the industry is filled with the technical writers who come from different backgrounds. Most of the technical writers are engineers, some of them have taken the technical writing course and some of them have made transition into this field from direct mass communication and journalism. The document produced by these technical writers has mixed quality as good, bad and ugly. However, most often the complaint received from the customer is that the documents are not user friendly.

If analyzed, most of the time the language is not very appropriate, clear and grammatically correct to explain the features and functionality. Some times the information presented does not have flow; sometimes many of the information are missing from the document. In nutshell we have not grown to a level to claim ourselves expert in the field of technical writing. One can say that this field is still in the nascent stage in India. Largely true, because our curriculum does not include this subject and we do not intend to take it as a career. Most of the people today who opt for writing career become journalists and join media related jobs.

The apathy is that most of the people who are today’s technical writers are not from the writing background, nor do they have inclination towards writing. It’s sheer job opportunity, which has drawn them to accept the job. Many of them working after a brief period have made a decision to shift to other fields and remaining are carrying on the task to continue their job. It’s quite ridiculing that the job what you do everyday is the job you do not like to do but you are bound to do because you are paid for that. Or, the job what you do is not your cup of tea. All these factors add to the immature technical writing produced by some of the unskilled technical writers, which brings bad name to the community.

The job what you hold today, is not just the job what you can hold because of the fact that you can write little bit of English. If you do not love your job then in fact it will not take you anywhere. You first be writer before you become a technical writer. As a matter of fact, you have to be first a writer to be a medical writer, political writer, and technical writer or fiction writer. If the writer is missing in you then nothing else can help you to become technical writer. Therefore, not only writing, but good quality writing is desired to be in this profession.

Can transition add value?

For many of the aspiring creative writer working as a technical writer might seem a good option because it is going to be paid well. If you are transitioning from your current non-writing position to technical writing because it's a hot market, you like technology, and/or you want to do away with your freelance tag, perhaps you are thinking right. But in case you just like writing, then you should think before you step in.

Writing and editing user manuals, help documents, technical bulletin and API document could be painful if you don’t love doing so. Technical writing is demanding and you will be tried writing different sort of technical stuff, which might not satisfy your liking for writing what you are looking for. So, before deciding to choose a career into technical writing, you must evaluate yourself.

Some would prefer to go for highly satisfying writing career of their liking even if it pays them less. Some would love to write about technology and enjoy doing so. Some would find technical writing as boring and unimaginative. Some would find technical writing as very interesting and creative, as it relates to problem solving and that requires lot of creativity. Follow your instinct to know where you fall among these categories.

What the technical writers meet and seminars stress upon?

Added to that the seminar and meet organized for the technical writers stresses upon learning different kinds of authoring and word processing tools, which is any way technical writers have to know to perform the task. I don’t know if any of the meet stresses to shape good language in spite of knowing that most of the technical writers come from non-writing background and that is going to be the bottleneck problem as they grow in their career. It is assumed that technical writers are basically the writers who has all the language ingredient in them to produced good writing and it’s the technical knowledge what they lack. Fundamentally, the assumption is right in the sense that you know what is expected out of you in terms of job and aim of the meet is to update you with new knowledge of the industry. Otherwise also, it’s the personal responsibility of the person to shape up their language skill who opts for this career.

Promise of global business

The reflection of good writing can be a visual part in any form, be it script, an article, an essay, an advertisement or a user manual. Especially user manual is supposed to be a first date with the product. Great manuals can sell products. There are good tutorials, which can make you understand the product so well that time and again you would love to continue with the same products.

But still there will be people who would still persist in search of your inner beauty. However, this is not the way to bet. Microsoft has consistently been trying to address everyone’s questions to make it competitive and have advantages. Still they may have messages. Above all to write the good manual you need to have good writers. And if you don’t have good writers your documents will not serve the purpose to the user. Bad documentation increases the cost of technical support and earns you even bad reputation in the industry.

Can we rise to the occasion and face the reality?

The best technical communicator is a technical person, is a subjective issue to argue. However, technical writers are the writers who have the rare ability to communicate and teach through indirect means such as paper and online media.

But it is very difficult to merely narrate a profession, which is entirely dependant on the personal caliber of a person. It is really a tough question to ask who can make a good technical writer. Many good writers who are able to write good story, poetry and fiction have many a times proved to be good technical writers as well and at a time bad writer too. Its all dependant on the personal interest what you could make of yourself

Possible solution?

Probably possible solution to stabilize this field in today’s context would be to hire really good writers so that they can justify their presence in the job. For the technical writers also, it would be apt to get out of the tag of half-writer, pseudo writer or be in dual job capacity being a writer and someone else too. If this field is to sustain well in India, the quality of writing has to be improved immensely to meet the challenge.