How do companies evaluate technical writers?

Printer-friendly versionPrinter-friendly version

Have you ever wondered how technical writers are appraised in a company?
Have you ever asked someone how technical writers should be apparaised?
Do you have any idea how your performance has been evaluated in a a company and what worked for you and what worked against you?

In Economics, there is a term called Externality. Wikipedia defines the term as "an impact on a party that is not directly involved in the transaction. Another definition is, "An externality is an effect of a purchase or use decision by one set of parties on others who did not have a choice and whose interests were not taken into account."

In real-life scenarios, technical writers have to deal with so many externalities. They have no "choice" to influence or know how their performance is evaluated. I have strong reasons to believe that technical writers are not evalauted based on their "writing skills" alone. I admit that mere writing skills are not enough for a technical writer to succeed. I do not even believe their "writing skills" are enough to get a good appraisal. Technical writers even do not know whether they are being "evaluated or not".

Then, how are technical writers assessed as a group in a company? A large number of externalities, ranging from favouritism, personal grudge, sexism, and so on, do influence the way technical writers are evaluated. If you do not talk to the person sitting next to you, but completes all your deliverbles on time, is it right to hit at you for not speaking to the person next? How prudent is it to assess technical writers with the same yardsticks used to evaluate programmers and testers?

Have you felt the irony that nobody bothers about the "writer" in a technical writer, who often get pulled up for vague externalities? Why are technical writers continuing in a career that often regards them as lesser mortals? Is your career bringing the best out of you as a technical writer? Does the company acknowledges your contributions in any form? Are you a writer?

Should we be discussing this instead of FrameMaker, wikis, and social networking?

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.

Fate of Technical Writers

Yes, it has now become evident that the technical writers do not get enough recognition for their efforts. The nature of work the writers are involved with is not as visible as that of developers or testers. They can be usually described as a low profile bunch of individuals who are considered less important compared to others in an organization. Irrespective of how efficient a writer is in writing, he or she is not at all evaluated on the basis of the writing capability alone. Nor the level of expertise in the authoring tools contributes in anyway to evaluate the performance of a writer. The unfortunate reason behind all this is the complete unfamiliarity of other team colleagues and senior level staff with the writing process, tools, importance, etc.. The mentality of such individuals is also a culprit behind all this happening with writers. It has now become a permanent problem with writers in all companies, except a few ones. And the situation is not likely to improve in near future, though efforts are on to improve the condition of writers in real. But, we need not be discouraged; & think about positives/assets that only this profession provides us, such as not so strenuous routine work with a handsome package, good home-office time balance, regular interaction with customer/client, chance to become a domain expert, start freelancing work, and many more...

--Saurabh

Technical Writers can be appraised

A technical writer can be appraised:
- By allowing assessment of the documents created by the writer
- Asking users how the help system was useful for them
- Assessing how the technical writer adapted to new tools, methodologies
- Assessing how all the information of the project was captured in the documentation, how the information was structured from a user perspective

One more issue faced by technical communication community that makes technical writers on a lower rung is:
- People from medical transcription, BPO, Call Center are entering technical writing. They have to understand that Technical Writing needs talent.
- Although entering Technical Writing is easy (on a lower pay), getting ahead is purely on talent
- More technicaly savvy men have to take up this job. Tech writing is dominated by women, who are supposedly good at writing. This trend should change. Men who write well do not take up technical writing, they would rather do something else.

Re: Technical Writers can be appraised

I was going through one of the older posts and I wonder what the writer means when the writer says this:
"More technicaly savvy men have to take up this job. Tech writing is dominated by women, who are supposedly good at writing. This trend should change. Men who write well do not take up technical writing, they would rather do something else."

Do this mean that women are not tech savvy, and are not fit enough to be technical writers?. While I agree that the technical writing community is dominated by women, I also know and have worked with a few women technical writers, who have had so much technical knowledge that they would even contribute in the product design discussion meetings.

One of the basic needs of the technical writing career is the ability to constantly learn and have a passion for what you are doing. If you come with the mentality that you know everythig, then you will never learn. This mentality leads to mediocracy.

I think the basic problem is with the mentatlity of people. Mediocracy comes from people, who have gender biased thinking and who have a supiriority complex.As long as poeple have passion for writing and aptitude for technology I don't see a problem if they are women, or if they come from medical transcription or any other background.

Companies having technical

Companies having technical writers are distributed between two sides of a coin – a shiner side and a darker side. When we say that the field is blossoming on the shiner side with some of the good companies recruiting technical writers, the darker side describes the attrition factor. It is hard to believe that there are few companies with CMMI and ISO certifications and are not able to define or understand the role of a technical writer. A technical writer’s work is seasonal and should not be compared to that of developer’s contribution though both of them are paid almost equally in few companies. Imagine that in a small product based company, a technical writer’s work would only depend on a single product release which is not the same with bigger companies wherein he/she might be working on a user guide, release note and training documents simultaneously because of the business the companies deal with. According to the eyes of the management, all workers should be productive enough to retain their place in the company else companies research to find new methods of firing the employees. This principle should not be correlated with technical writers. After all, technical writers are endangered commodity. We need to harness them before this community’s presence is lost.

Regards,
Srip

Technical Writer's Evaluation

I don't think that Technical Writers are not treated well in Software Companies. Lot depends on your own attitude. I am currently working in a reputed MNC and getting all the respect and appreciation that any professional (TW, SE, BA etc.) should get.
I think this feeling of not getting equal respect is somewhere within us. I believe that your profile cannot define how much respect you will get; it’s always your attitude towards your job (no matter what you are doing).
Work hard and be proud of what you are doing.

Brilliantly put!

Dear Anonymous,
I wasn't planning to enter into this discussion, but your comments left me tingling with admiration - very succintly put! The feeling of not getting respect is really somewhere within us. It is fairly obvious that the comment written by tech-writes has some sort of background about which I know nothing, but it's also true that I've seen the office sweeper getting more respect than the Manager HR at times. Why? Because of the honest quality in one's work, and the desire to be unselfishly useful to everyone around us. I call it the total-quality-total-care paradigm. (Don't we all have an office chaiwalla or peon who gets love and respect from everyone whenever he appears?)

Frustration springs out of a clash of interests. Too often, our work is so oriented towards salaries, incentives, respect and recoginition that we forget the joy that is inherent in working for the love of work and the joy of being a contributing member of society. Maybe it's a cliche', but the old saying stares us starkly in the face at times:

"I used to complain I had no shoes, till I saw a man who had no feet."

We can only be exploited if we've left all the keys to our satisfaction at the mercy of others' behaviour. That's when we're begging to be robbed, and soon we're left emotional paupers.

Finally, in answer to the last question raized by tech_writes, yes, we should be discussing FrameMaker, wikis, and social networking extensively, because writers who are really skilled, both technically and in social etiquette never find themselves unwanted or disrespected in any environment.

Warm regards,
Tabir Mishra

Excellent

Mr Tabir,

When you say that feeling of not getting respect is really somewhere within us, you are absolutely correct, but who is responsible for such a feeling? How did it develop inside writers? Surely, there must have been some factors that the experienced writers would have noticed after working for some years. Your comments look very good and teach a lot to freshers looking for his first job in Technical Writing, but are a bit impractical considering the real scenario. Your example --"I used to complain I had no shoes, till I saw a man who had no feet." might help writers in becoming satisfied with whatever they get. Why should we become so negative? Why should always writers compromise and not think high as other professionals?

Regards,
Saurabh

Please Clarify

Hi Saurabh,

Can you please clarify exactly what compramises a technical writer has to make and what 'extra' benefits other professionals are geeting.

Thanks for the comments

Mr Tabir, if you know how your company evaluated the "quality" of your work, then it is very good and all the best to you.

I am worried about a majority who do not know and those who have not yet bothered to check how the management has judged them. In many occasions, tehnical writers do not know the expectations set for them and there is no "standard" by which they are judged. And those who are in the technical communication profession for quite a while know how tech writers are evaluated compared to the "technical people". It is also upto the individual whether he
or she wants to be "useful" to the whole office or company.

Tools do not matter if the technical writer does not know how to write well. You can teach FrameMaker to a technical writer, but not "writing".

Moreover, I do not feel that my experience is the end of the world.

Techwrite

Is there a contradiction in our approaches?

Dear Techwrite,
1) Your concern for the technical writer community is laudable, and is reflected very well in your blog. I merely took the liberty of furthering your thoughts by pointing out how we can avoid frustration in our work environment - again in accordance with my personal experience only. It would be really useful to the technical writer community, if those who are in a position to judge their subordinates, reveal how they do so. Being in such a position myself, I have put forward my views without the slightest intention to contradict you; probably with a view to furthering your point.

2) Yes, it is up to the individual whether he or she wants to be useful or not, but then a decision to take a path leading to tension and then complaining about it cannot be called a sensible course of action. For example, if we are unhappy about the discrimination against us, maybe we could proactively think of a change in job, else a change in job profile. I've done so myself at a fairly senior age and senior position, so I can assure you that I know the kind of courage and struggle it entails. My continued gratitude to the members of the TWIN forum who helped me out at that critical juncture just a few months ago. My point is, that if we don't like getting wet, we don't complain; we open an umbrella!

Yes, our skills as Technical Writers are important, but to do well in a work environment one must be a good writer and also a good employee. What does this mean? Interpersonal skills, contribution to the overall work environment the ability to motivate others, the ability to take initiative in areas which are technically not ones domain to further the interests of the company, are skills that any employer or manager appreciates. Somehow I feel that the discrimination may not be so much against the Technical Writer. It sometimes boils down to a lack of team spirit. Again, these are just my views, I could be wrong.

3) I support your view entirely, that one who takes on the responsibility of being a technical writer must first know how to write well. Tools are important, but they can come later.

4) Your experience is valued, especially since you have chosen to share it openly on a forum such as TWIN. I hope I have not in any way belittled your views in my enthusiasm. If I have done so, please accept my apologies. I submit myself to being corrected in whatever way you deem fit! :)

Peace and joy be with us all,
Warm regards,
Tabir Mishra

There is indeed a slight

There is indeed a slight contradiction in our approaches. When a technical writer undergoes a performance appraisal, the pertinent question is on what "exactly" is the employee assessed over a period of time? What exactly is "performance" for a technical writer? For example, is it the writing and editing skills, tool skills, planning and estimation skills, project management skills, team player skills, information gathering skills, information design skills, content development skills, technical skills, domain learning skills (old and new), or simply submission of deliverables on time, and so on. If it is indeed a combination of all these, then how proficient are companies to measure these metrics?

Unfortunately, most companies do not have such broad criteria to measure a technical writer's worth. In most cases, these appraisals have more to do with personal equations and prejudices combined with metrics supplied by the HR department. The appraisals gets more complex for outsourced projects. Both the onsite and offshore managers try to micromanage projects making it more difficult for the techncial writers.

What I wanted to suggest is that companies need more "professional and practical" approaches to manage and evaluate technical writers. Current approaches remain very vague and simply do not do justice to the upcoming technical writing community in India. Technical writers have the right to know how the company have measured their contribution and performance, how past performance will be used (for and against), and how appraisals affect career advancement and success. As you know, only a happy employee will be a good and dedicated employee.

Regards,
Techwrite

Dear Techwrite, In the

Dear Techwrite,

In the Appraisal process, a Software Engineer is also not evaluated on how mush hours he/she worked, his/her R&D skills, his/her knowledge of the technology etc. All these things are already evaluated in the recruitment process.
In any company the appraisal is done only on the basis of how much relevant work you have done in your last financial year. In short how much VALUE ADDITION you have done to the project you are working on.
Company has already evaluated your writing skills; tool knowledge etc. while recruiting you. They will not repeat this process while appraising you. They will appraise you only on the basis of how useful you are for them.
I know in many companies Technical Writers don't have much scope for VALUE ADDITION because they are usually involved in formatting, editing of existing documents. But where Technical writers are involved in proper documentation (writing manuals, illustrations, case studies, training materials, installation guides etc.) they have a good scope to mark a difference.
Before joining any company as a technical writer you should ask that what will be your job responsibility. If you feel that your responsibility in that organization is limited to formatting and editing then there is no point in wasting your time with such companies. Move on and find the organization where documentation is important.
There are many software companies where technical writers are doing really good job. I am working on insurance product documentation and finding it very challenging. I think I have loads to say in my appraisal meeting and to convince my manager that deserve a good hike.
If you want to reach at the top, prove yourself that you are worth reaching there.

Hi Neha, your comments have

Hi Neha, your comments have forced me to ask the same question. How will the company measure the 'relevant work' or 'value addition' a technical writer has done? What are the parameters commonly used to evaluate 'how useful' a technical writer is to the company?

I disagree that writing skills are not evaluated after recruitment. I think it is another topic for discussion. Do you think that companies will disclose details of the projects they have while interviewing candidates?

This post was not written by a 'worthless' techncial writer. I had an excellent year with my company and I see no changes this year also.

FYI, formatting and editing do contribute to value addition. Because what is at stake here is the company's image and position in the international market. A good company will have standards and guidelines in place, even for a marketing collateral, and the consistency and quality of their docs reflect how good and how professional they really are.

Regards,
Techwrite

Hi, Your statement "This

Hi,

Your statement "This post was not written by a 'worthless' technical writer" shows that you are taking things personally and being offensive. The last line of my previous post was very generic (written in second person) and certainly was not pointing to you. If you are on the discussion forum, please do healthy discussion. Please don’t take words personally.
Q: How will the company measure the 'relevant work' or 'value addition' a technical writer has done?
A: Success of any project depends on the acceptance of that project by the client. Success of the product depends on the competition in the market.
For a Technical Writer, if all the documents written, reviewed, formatted by him/her are technically correct (all the processes are accurate), well formatted, delivered well in time and well accepted by the client then that technical writer is performing well and his work is ADDING VALUE in the delivery of the project.
Q; What are the parameters commonly used to evaluate 'how useful' a technical writer is to the company?
A: If the work done by the technical writer is well accepted and appreciated by the client. Also company is able to bag documentation module for other projects because of the quality work delivered in one project then that technical writer is certainly useful and any company would like to retain that writer.
Basic Skills like Writing, Tool knowledge, Domain Knowledge etc are evaluated at the time of recruitment. Special skills like:
•Team work: Efficiently working with developers while integrating online help with code
•Eye for detail: Able to point out bugs by thorough study of application.
•Self starter: Giving ideas to the team on how to improve the user interface (though this might not be the part of your job), coming up with the additional documents (other than what is assigned to you) like Did you know and How Do on the technology your team is working on.
are examined throughout the year by the managers, leads. These skill sets then form the basis of appraisal.
During recruitment a Technical Writer might not know about the project details but he/she can ask about his/her job responsibility in that organization.

Neha, whatever you have said

Neha, whatever you have said is fine. But my question is how will technical writers ensure that they were evaluated properly. What are the checks and balances to ensure that you do not get a raw deal.

Regards,
Techwrite

Practical Approach

Hi Techwrite,

Evaluation during Recruitment
Like any other profile, technical writing also has some salary standards. Refer:
http://www.stc-india.org/activities/surveys/STC_India_2005_Salary_Survey.pdf

If a technical writer thinks that he/she not getting as per the standards then he/she should not accept that offer.

Some technical writers complain that salary that a technical writer is getting is less than a software engineer. This is what I feel:

• Technical Writer’s qualification background varies from B Com, BA, MA, MCA, BE etc. In a software industry if a commerce graduate or an arts graduate (no offence meant) is comparing his/her salary with BE, ME or MCA software engineers or MBA Business analysts then I really think this is not fair. We should be more practical before asking any such question that why a technical writer get less than a software engineer. The answer is simple they are much more qualified and doing tough job of development. Working 16 hours a day. Having no weekends. By this I certainly don’t mean that our job is easy or inferior but I think we are getting sufficient for the amount of work we are doing. If we want to earn more than we can work more. Normally a technical writer in a software company doesn’t have to work after 6 in the evening (SE working till 9-10 PM). On weekends also I am sure that this profile doesn’t demand much. WE HAVE TIME TO EARN MORE…..

Evaluation during Appraisal:

• All of us get the chance (most organizations follow this practice) to rate ourselves in different areas like knowledge; team work etc by filling a form before appraisal meeting. If we think that are really good at these areas then we should give ourselves good rating. If our managers rating are different from ours then we can talk it out with our manager during the meeting. I think this process of rating is quite systematic and give a fair chance to the employees to put their points forward in the appraisal meeting.

• Those companies that does not follow the rating process and directly have one on one meeting then also you should feel free to put your points forward. If you are confident that you have performed well then I am sure you will have many points to convince your manager.

• I don’t think your profile has to do anything when it comes to getting a hike. Normally 20-25% hike is considered good in the normal (not going through recession) financial year. If you are getting this much you should be happy.

This discussion stems from the lack of conviction..........

Hi,
This discussion stems from people with lack of conviction that Tec Docs are an important part of the SDLC.
Tech writers often compare themselves with programmers and feel coding is better than writing. Actually anyone can code if they have education and experience, but not everyone can write. Writing needs talent.

Although writing is not as tough as coding, did you notice most programmers can't write a decent sentence! that's why we are there!

Also, tech writing depends on applications, and domains. Seems like all the above entries are from people who have never really documented complex applications or worked in complex domains. Once you do that, you will know the value of a technical writer.

How do companies evaluate technical writers?

I think, you need to be:
1. More proactive [especially while dealing with the documentation bugs filed by customers], anticipate what else the end-user might need and add it in the guide.
2. Gain more domain and product knowledge, so that your document is not superficial; it gives more technical information ["Enter name in the name field" is not enough]
3. Come up with innovative ways to present information/facts - one such example is using Flowcharts
4. Prepare new writers to be productive at the earliest

Hi Utpal, a software guide

Hi Utpal, a software guide reflects the software. If the software is not user-friendly, then a guide cannot alone save it. The level of technical information depends on the audience. I do not think that users would keep on looking at flow diagrams to complete a task.

It would be interesting to know what the "enter the name in...really means. Did not quite get that part of your comment.

Regards,
Techwrite

Well I believe that first

Well I believe that first criteria to evaluate the performance of a technical writer should be a measure of how useful a document/set of documents written by the writer was to the target audience.

I say this because I believe that a document that does not meet the needs of the audience cannot be considered an effective document - no matter what technology or methodology was used to create it.

With this principle in mind, I think the following criteria should be used to evaluate a technical writer's performance.

  • The number of technical errors - to find out how familiar the writer is with the product and the technology. The lesser the errors, the better the writer scores.
  • The number of grammatical errors - to ascertain the writer's proficiency with the language. Again, the lesser the number of errors, the better the writer scores.
  • The number of technical support requests that the customer support team receives for issues that could have been addresses in documentation. Again the lesser these errors, the better the writer scores.
  • Adherence to deadlines - This is particularly important because this has an impact on the timelines of the entire release schedule of the product. Any consistent deviations from the schedule also increase the cost of the project - which might be viewed negatively by management.

My two pennies...

Feel free to comment.

Hi Techwrite, It is obvious

Hi Techwrite,

It is obvious that you have experience in this field, have made valuable contributions, but somewhere down the line things are not as exciting for you now, largely let down by the "non-transparent" appraisal system, perhaps in your company. Just as you have put forth this topic for discussion in this forum, have you ever gone back to your appraiser and voiced your very valid concerns? If you want the system to be transparent, spell out the appraisal parameters, and ensure that it does justice to you and your work, then your review team should be faced with these questions.

There will be an element of bias in every aspect of your life, sadly it is taken to extremes in some instances, and you were right in saying that these are factors you cannot control. To answer your question as to how will techwriters ensure that they are evaluated fairly is an extremely hard question to answer. The fact that you have received numerous responses to it exemplifies it. It is also worth remembering that the job we do is more quality driven than quantity. Am glad it is quality as you have a real chance to stand out in the crowd (good or bad!). So instead of being disgruntled, please also raise this with your company, and if possible share the non confidential aspects of it with the community.

Cheers!
KS

Dignity of Labor

I don’t think it is beneficial to intensify this debate further. We are living under the same roof and are passionate about our work. Every work has its own sheen and flavor and it is not right to compare between cross functional capabilities. Having understood that the debate is a hot topic, it is not right to argue among us to the maximum extent when we are labeled as technical writers. I understand that every member has the right to put forth their words but the situation looks like we are degrading ourselves and creating an inferiority complex. What we need to look forward is a system. A system, where there is a proper evaluation of technical writers during recruitment, proper understanding of a technical writer’s job and motivation for overall development. It is not right to compare with developers, when there are still loopholes in our field. Let us get these loopholes filled and then raise our voice if required.

Let us live in harmony and abide by the motto “Dignity of Labor”.

The salary survey link provided by one of our readers is not the latest one.
P.S: The latest salary survey is available in the link http://www.stc-india.org/activities/surveys/STC_India_2008_Salary_Survey_Results.pdf

Regards,
Srip

Thank you all

Hi guys, thank you very much for your excellent and thoughtful comments. It was a brilliant exchange of ideas.

Regards,
Techwrite

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.