Pitfalls of Technical Writing

The documentation need does not always grant good status and valuable position for technical writers in any of the product development company. Most often when you interact with the technical writers, they do not seem to be very much willing to let you know where are they heading towards in their career or they are happy about their role in the organization. The truth is that they themselves do not know what is their fate except the fact that they have a job, which is paying them well presently.

Ask most technical writers about their workplaces and you will likely to hear the same complaints. The developers do not follow any specs and never tell what they are up to. They slip their schedules by months, but the minute they are done, you are supposed to have the docs ready, like by magic. The developers and development team is the hub of activity and the core team in any product company. Obviously, this is. However, it is not only the team in the organization. If so, does organization not need other teams like testing, documentation and SQA team to work simultaneously. So, why is there a bias?

Worst over, most of the developers are bad in their verbal and non-verbal communication. If you learn their English, you forget yours and that is the end of your year’s toil of learning little bit of English. Yet, they will only meet the customer with their lanky, unshaven English language. The scenario is, you keep on changing the job and everywhere you go, you will witness the same thing happening. Moreover, many a times you report to your boss who does not have slightest idea about what you do and what it takes to do such job.

I remember, in my last company, a Software Requirement Specification document was returned to our development team with the comment that it contained 90% language error and it can not be accepted in its present form. We had to do the cleaning and correcting of the entire document to make it presentable. Yet, Technical writers are often struggle to prove their Return On Investment in absence of any established metrics for measuring it. Irony is that technical writers can make difference in any kinds of the document organization produce, be it client serving documents or archival documents, yet their importance is highly misunderstood.

The fact remains unimportant to many of the organization’s biggies that high quality documentation can make a big impact on customer satisfaction. It increases usage, gives more successful implementations, and creates better references and happier customers, which then drive more sales. It is an image-uplifting act which most of the organizations fail to realize. Good documentation can sell even product. You can have competitive advantage over your competitors of having high quality documentation.

Today, the ratio for developers and technical writers are somewhere 20 or 30:1. This is for the obvious reason if the bosses are Technical person they value that art more than anything. That also reflects the poor image one organization has toward it's documentation. Organizational chart does not show a progressive look to the technical writers. Many organizations have typically failed to sustain because of the dearth of enough documented archival knowledge, which helps most of the new employees to understand the background of the product.

Although technical writer’s whole job is about communication, they are sometimes the last to hear about future development plans or last-minute changes to a release. Truth is, Tech writers are good advocates for the user, always thinking about the user's point of view and they can make valuable addition in the development of the product.

Technical writers do tend to be the user's advocate, arguing for clarity and logic in everything from error messages to how features are implemented. But that's hard to do when you never talk to any customers. Even the customer’s feedbacks are shelved with customer support department, leaving technical writers imaginative on their own.

Technical writing is no black magic and if many feel, any one can become, they are wrong. English is no short cut, which can be learnt in a year or two like Java or C++. This field is in nascent stage and growing horizontally in sheer numbers. Today, technical writers are joining the band wagon, but it is not too far that these writers would be evaluating and weighing their career goal in terms of their achievement on vertical ladder. Future will hold the platform where technical writers will make it big or break.