Today I attended a session of the Mumbai chapter of the Society for Technical Communication . The first session was by Gurudutt Kamath, who is probably the most well-known figure in the tech writing community in India. My interest in attending the session arose cause someone I know was also speaking there, and also because a lot of the work that we do involves a significant amount of technical writing. So while, we may not be professional technical writers, consulting does require us to have excellent written communication skills.
Guru (as he is popularly known) was speaking on common errors in technical writing. I think many of these errors occur in daily business communication as well. He made it a pretty interactive session, so the other tech writers also piped in with the errors they have seen occur most often. Here's the list we came up with:
- Not identifying the purpose of the document. Each document should have a set of objectives and a context in which it is being developed. Is it a user manual, or a marketing collateral, or something else. This leads us to:
- Not identifying the right target audience. If you don't know whom you're writing for, you're quite likely to miss the mark in terms of getting your point across. You could come across writing increasingly dumbed-down documents, or your writing could be so filled with jargon that it would be impossible for the average reader to understand. Having identified the target audience, you need to be sure that the next error is taken care of:
- Not getting the right sample audience to review your document. The right reviewers can make a huge difference in the final quality of your writing. I have often had non-technical editors review some pretty technical articles, and miss out on stuff that a more technical reviewer would easily have helped improve upon. Some of the better journals have a peer review system, so you ensure that a wider sample audience reviews your writing. A lot of the times, we end up submitting stuff without review - which is almost sacrilege!
- Inconsistency. Whether it's your formatting styles or your use of numbering systems, or your choice of words (British English or American English or apna Indian English), you have to be consistent. This also applies to:
- Not selecting the right examples. Guru gave the example of an article, which was about choosing relevant examples, and was woven around Amercian baseball. Now the author might have written the original article for an American audience, but by the time it got syndicated, it was published in other regions, where most of the baseball metaphors fell completely flat.
- Common grammar and spelling mistakes. "It's" vs. "Its". Not pressing the F7 key. Enough said!
- Wrong references. In larger documents, references to sections or figures within the document can go wrong when the document changes. For a book, that I was recently co-authoring, I had to keep changing the references to snapshots and figures as I kept inserting more, requiring me to renumber the earlier ones, as well as change references to them. Apparently, the right way to do it is to add a reference field, and point it to the location within the Word document, so that when the referenced section changes, the reference changes with it.
- Cookie cutter nightmares. Ok, so we've all done this. Opened up a previous proposal or report, and simply pressed File Save As, and the old client name pops up in the most embarrassing places. We once failed to get a customer reference, because during the closing meeting they brought up the point that they had been put off because an old client name had cropped up in one of the documents we had submitted in the project. Based on the inputs from the other participants in the session, this happens to the best of them.
- Use of cliched graphics. Using the MS supplied clip art in Powerpoint presentations, not getting the graphics done professionally, and using irrelevant graphics. Of course, Powerpoint gaffes are a whole thesis subject by themselves.
- Punctuations errors. I am most guilty of these, especially with mis-placed commas. Just don't seem to get them in the right places! Other errors include inconsistent quotation marks, misplaces colons and semi-colons, the use of ;& instead of 'and', etc.
13 comments:
Hi
I am a regular reader of yuor blog. Your writing has further boosted my interest in starting a one-person company.
Thanks for all those useful articles.
I am a consultant editor working with one of the top IT companies in India. I am planning to start a web-based content development and editing services first before quitting my job. Your blog has helped me a lot. Keep writing. May God bless you for a healthy and wealthy life. It's people like you our country wants.
Regards
Girish
www.contentcocnepts.net
contentconcepts-at-gmail-dot-com
Girish, thanks for all the kind words! :) Helps to ensure that I keep writing stuff along the same lines. Often one begins to question whether one is writing the right stuff or not. Your new venture sounds like it has an online business model. So do pay lots of attention to SEO. And ping me if you need any specific info. All the best!
The last link http://everydayentrepreneurs.blogspot.com/2006/10/tc.eserver.org/authors/Kamath,_Gurudutt_R
does not work
The link should be to http://tc.eserver.org/authors/Kamath,_Gurudutt_R
Good design!
[url=http://tpvcwsbu.com/huuw/efcq.html]My homepage[/url] | [url=http://gzqicncf.com/jinl/iwrf.html]Cool site[/url]
Do you know anyone that has success in breaking into the Indian Technical Writting, Information Mapping, or Content Management business from the USA?
Thanks for ur great tips for writing the technical writing.These fatal errors must be reduced so that we can get the best tech writing.
I have visited your blog for the first time and found it a well organized blog.
Keep sharing nice stuff.
Technical Writing in india
We are thoroughly impressed with our new office space in Bangalore Embassy Golf-Links Business Park. The premium location on Bangalore and the well-appointed suites and meeting rooms are ideal for our business. The staffs at stylus are very friendly and they support us very much. The office and its working atmosphere are great and serves our needs to a tee. If anyone is looking for a virtual office or office space in Bangalore I highly recommend Stylus Office Space.
Watch here: http://www.youtube.com/watch?v=MSkZ-1wB7IQ
HI Very good and useful information .Thanks for sharing .Keep up the Good work
Hey, very nice site. I came across this on Google, and I am stoked that I did. I will definitely be coming back here more often. Wish I could add to the conversation and bring a bit more to the table, but am just taking in as much info as I can at the moment.
Thanks for sharing.
http://worldfamousastrologerinindia.in/
Love Problem Solution
Love Problem Solution
Girlfriend Vashikaran Specialist
Get Love Back by Vashikaran
Love Prolem Solution in Delhi
Husband Wife Problem Solution
Vashikaran Specialist Astrologer
How to Get Lost Love Back
Love Marriage Problem Solution
Love Vashikaran Mantras For Ex-Love
Intercaste Love Marriage Problem
How to Stop Extra Marital Affairs
Love Marriage Specialist
Love Mrriage Problem Solution in India
Love Problem Solution in USA
Love Problem Solution in UK
Vashikaran Specialist
Love Vashikaran Specialist
Boyfriend Vashikaran Specialist
Get Extra Marital Affairs by Vashikaran
Love Vashikaran in Ahmedabad
Husband Wife Vashikaran
Vashikaran Specialist Astrologer in Gujarat
How to Get Love Back
Love Marriage Vashikaran
Love Vashikaran Mantra For Boyfriend
Love Vashikaran Mantra For Girlfriend
Vashikaran Expert Jyotish in India
Vashikaran Specialist in Vadodara
Vashikaran Specialist in USA
Vashikaran Specialist in UK
Vashikaran Specialist in Canada
Black Magic Specialist
Black Magic Solution
Black Magic For Girlfriend
Black Magic For Boyfriend
Black Magic For Enemy
Get Love Back by Black Magic
Black Magic Specialist Astrologer
Court Case Solution by Black Magic
Love Solution by Black Magic
Black Magic For Ex-Love
Black Magic Removal
Black Magic For Extra Marital Affairs
Black Magic For Business
Black Magic Solution in India
Love Problem Solution in USA
Love Problem Solution in CANADA
Other Astrology Service
Karmkand Astrology
Kundali Matching
Career Problem Solution
Career Problem Solution
Business Problem Solution
Job Problem Solution
Visa Problem Solution
Family Problem Solution
Children Problem Solution
Marrige Problem Solution
Best Astrologer In Ahmedabad
Best Astrologer In Delhi
Best Astrologer In Mumbai
Best Astrologer In USA
Best Astrologer In Canada
HI Very good and useful information .Thanks for sharing .Keep up the Good work
Hey, very nice site. I came across this on Google, and I am stoked that I did. I will definitely be coming back here more often. Wish I could add to the conversation and bring a bit more to the table, but am just taking in as much info as I can at the moment.
Thanks for sharing.
http://astrologyindia.in/
Love Problem Solution Ahmedabad Gujarat India
Love Problem Solution Ahmedabad Gujarat India
Girlfriend Vashikaran Specialist Ahmedabad Gujarat India
Get Love Back by Vashikaran Ahmedabad Gujarat India
Love Prolem Solution in Delhi Ahmedabad Gujarat India
Husband Wife Problem Solution Ahmedabad Gujarat India
Vashikaran Specialist Astrologer Ahmedabad Gujarat India
How to Get Lost Love Back Ahmedabad Gujarat India
Love Marriage Problem Solution Ahmedabad Gujarat India
Love Vashikaran Mantras For Ex-Love Ahmedabad Gujarat India
Intercaste Love Marriage Problem Ahmedabad Gujarat India
How to Stop Extra Marital Affairs Ahmedabad Gujarat India
Love Marriage Specialist Ahmedabad Gujarat India
Love Mrriage Problem Solution in India Ahmedabad Gujarat India
Love Problem Solution in USA Ahmedabad Gujarat India
Love Problem Solution in UK Ahmedabad Gujarat India
Vashikaran Specialist Ahmedabad Gujarat India
Love Vashikaran Specialist Ahmedabad Gujarat India
Boyfriend Vashikaran Specialist Ahmedabad Gujarat India
Get Extra Marital Affairs by Vashikaran Ahmedabad Gujarat India
Love Vashikaran in Ahmedabad Ahmedabad Gujarat India
Husband Wife Vashikaran Ahmedabad Gujarat India
Vashikaran Specialist Astrologer in Gujarat
How to Get Love Back Ahmedabad Gujarat India
Love Marriage Vashikaran Ahmedabad Gujarat India
Love Vashikaran Mantra For Boyfriend Ahmedabad Gujarat India
Love Vashikaran Mantra For Girlfriend Ahmedabad Gujarat India
Vashikaran Expert Jyotish in India Ahmedabad Gujarat India
Vashikaran Specialist in Vadodara Ahmedabad Gujarat India
Vashikaran Specialist in USA
Vashikaran Specialist in UK
Vashikaran Specialist in Canada
Black Magic Specialist Ahmedabad Gujarat India
Black Magic Solution Ahmedabad Gujarat India
Black Magic For Girlfriend Ahmedabad Gujarat India
Black Magic For Boyfriend Ahmedabad Gujarat India
Black Magic For Enemy Ahmedabad Gujarat India
Get Love Back by Black Magic Ahmedabad Gujarat India
Black Magic Specialist Astrologer Ahmedabad Gujarat India
Court Case Solution by Black Magic Ahmedabad Gujarat India
Love Solution by Black Magic Ahmedabad Gujarat India
Black Magic For Ex-Love Ahmedabad Gujarat India
Black Magic Removal Ahmedabad Gujarat India
Black Magic For Extra Marital Affairs Ahmedabad Gujarat India
Black Magic For Business Ahmedabad Gujarat India
Black Magic Solution in India
Love Problem Solution in USA
Love Problem Solution in CANADA
Other Astrology Service
Karmkand Astrology Ahmedabad Gujarat India
Kundali Matching Ahmedabad Gujarat India
Career Problem Solution Ahmedabad Gujarat India
Career Problem Solution Ahmedabad Gujarat India
Business Problem Solution Ahmedabad Gujarat India
Job Problem Solution Ahmedabad Gujarat India
Visa Problem Solution Ahmedabad Gujarat India
Family Problem Solution Ahmedabad Gujarat India
Children Problem Solution Ahmedabad Gujarat India
Marrige Problem Solution Ahmedabad Gujarat India
Best Astrologer In Ahmedabad
Best Astrologer In Delhi Ahmedabad Gujarat India
Best Astrologer In Mumbai Ahmedabad Gujarat India
Best Astrologer In USA
Best Astrologer In Canada
Best virtual Office in Mumbai with Business Registration and Prime Location
Virtual office space basically provides a great saving to a startup majorly for the boot strapped ones as they can have a virtual office space in other cities which is considered as the communication address along with the mail handling facility. It is beneficial for companies which are registered in 29 States all over India but need a communication address across different locations.
"Your blog post is a treasure trove of practical and useful information. The clarity of your explanations makes complex topics accessible, and I appreciate the effort you've put into making this a resourceful read. Keep up the excellent work!"
Post a Comment