User Manual in support of Science Research

Writing user manual or help for analytical tools, in support of science research is always a challenge for writers, not only for its technical accuracy but also in terms of knowledge transfer. This involves good amount of knowledge percolation, and precision in language before it goes for the technical correction.

Some of the custom research analytical tools consist of numerous algorithms for computing the data to suit the requirement of the analysis. Evidently these tools are meant for highly knowledgeable audience who would like to use these tools in pursuit of achieving unknown facts. The analyzed data may be used to make hypothesis in the area of research or made it public for some other to validate, make relation and further predictions.

The basic aims of user guide or help is to lead user to familiarize different functionality and features of the tools to achieve desired result. However, when the analytical tool is a niche product, the job of a technical writer becomes tough. The confusion begins when technical writers do not know the knowledge level of the audience. Even when they know, it is sometimes misleading. For example, if you consider that all the analytical scientists and researchers have computation algorithm knowledge then it might not hold true to the whole class. Most of the time, it may incidentally become true that audience for whom you are writing user manual finds it useful and have no doubts performing the tasks they desired to do.

But most of the times it will not be so, some of them in spite of knowing and able to perform the tasks will come back to you to verify that how they are doing is the right way. Some of them will come back to you seeking knowledge looking beyond the beauty. Some will have comparative tastes to analyze the results derived differently with different tools. These audiences will seek detail knowledge of the logic and algorithm. Sometimes they will have a quest to know the comparative analysis of the similar tools available in the open market. The fact is, scientist and researchers like to verify and validate before they accepts anything. That’s how the science evolves.

These are too many things to do. The question is: can your user manual or help answer all these questions? Ideally it should not, but looking at another perspective it can carry as much knowledge as possible. But, how much, is yet again a question. Nevertheless, even if you have mega size manual, there will still be some message for you.

However, saying so, involves great amount of energy to compile the required content into the user manual. This is the primary job of a technical writer but it requires evidently all the stakeholder to contribute in to making of the manual. It is like sewing the cloths with fine needles.

Task looks Herculean, but it helps audience a lot in case of developing a tool in cutting edge technology. That is the primary goal of a user manual. Never to forget, one satisfied user can bring you ten more other users for your product.

Testing Time

Job Market is terribly down but most often, on an average, I receive around 5 mails seeking Technical writers in various Software organizations. Some of the organizations have sent mails umpteen times for the same position. I wonder these organizations are really hiring writers in this down time. But looking at the advertisements and consultant’s mail it looks that there is demand for Technical Writers in the market. At the same time I look at two of my friends who are searching for a position as a technical writer for past two months but so far they have no offers in hand. Weighing both the sides I am bit confused and not able to conclude as what is happening in the market and is there really a demand for the technical writers.

However, this reminds me of the situation when there is no hope organization conducts interview to keep job seekers hope alive. To a certain extent it seems alright but if there is absolutely no hiring then this fake exercise becomes counter productive. But who knows what Ramlinga Raju did in Satyam, some other CEO might be doing in other organizations. Interview the Job seekers and keep them in the fake payroll and siphon the money on the part of their salaries. Otherwise, two of my friends running pillar to post for past two months and attending more than ten interviews would have had at least one offer in hand. They both have more than 3 years of experience in Technical Writing. If I recall, till October 2008, if you get 3 calls you could be having 2 offers in hand. Message seems to be loud and clear, but to believe in this, is to leave the hope of future. It is not only my friends alone, it could be even me …….. I am scared, disappointed, and worried.

But looking at the questions what one of my friends in one of the interview was asked, it looks as if it is pass time for the recruitment department of the organization. To keep the recruiters busy, job seekers are grilled without any outcome. The real requirement is difficult to analyze. At this point of time when the interviewer’s future is itself in dark, they shoot question such as ‘What is the future of Technical Writing in India?’ Another one asked, ‘Are American writers better or Indian?”

My friend, who faced the interview, did not know how to answer these questions. Nevertheless, till now a facade is created in India especially in software industry that technical writing has very good career and suddenly technical writers are to face this reality. When you do not have job in hand, can you say that this industry promises lots of opportunity for you. Secondly, American and Indians alike are on the firing line and every one may be in the hit list to be fired. Finding out, who is better, that too from a perspective job seeker is utter foolishness. One of the friend rightly once said, ‘Recruiters are now looking for Pankaj Mishra, Arvind Adiga and Arundhati Roy to be technical writers. May be they might ask even Salman Rushdie to do this job.’

I can understand, it was seer frustration but the way he has been treated makes him say so. The postmortem of these interviews presses you hard to do the soul searching, whether you have a place here or not. Well, to say a little about the recruiters, they are nuts and they can pose any sort of questions to you without they themselves even knowing the answer. At a time they feel they are great and they can screw any person during the interview. But tide will turn, if you don not realize the value of good assets now, in the good time they will not recognize you. I mean your organization. These are passing phases and good turn in economy is expected. The crux is how well you can help job seeker contain their aspiration and motivate them to keep their hope alive. Of course technical writing will remain existent even though some of the technical writers find it tough or struggle to get a job. India is emerging as a promising destination for software industry and it will continue to evolve even in documentation. These are just testing time.