| |||||||||
|
1. #19726 I started by saying that I wish to make everyone a technical writer. But I think I have taken the easy way out and am saying everyone is a technical writer. Welcome to technical writing! Kamath, Gurudutt R. ITpeople (2000). Careers>TC>Writing>Technical Writing 2. #22689 The Art of Writing Technical Articles My advice for those wish to become writers: Write! Write! Write! I have always maintained that great writers are born, and professional writers are made. In the born writers there is an unquenchable thirst for writing, a passion for writing. Writing is a mission. Writing is the soul of the person. The professional writer does it for a living. There is a deadline and the writer can churn out the required number of words. Kamath, Gurudutt R. IT People (2003). Articles>Writing>Technical Writing 3. #22604 There has been a tremendous growth in the software industry and some growth in technical writing. Most of my columns ten years ago were rants about the poor state of our manuals and our software. Today, I think the humblest of companies is producing great stuff. The reason for it is simple--globalisation and the Internet. Kamath, Gurudutt R. IT People (2002). Careers>Writing>Technical Writing 4. #22601 An index is a vital part of a user manual and a help file. A manual without an index is like a 21-storey house without a names board on the ground floor. You will have to search through all the floors in the building to locate your friend’s residence. Kamath, Gurudutt R. IT People (2002). Articles>Indexing>Documentation 5. #22693 Creating World-Class Documents The world chooses India for software development. But this is not true for documentation. Having written User Manuals and Online Help mainly for software exports companies for the last 15 years, I can claim to have written for the world market. Kamath, Gurudutt R. IT People (2003). Articles>Writing>Technical Writing>India 6. #22694 One of the advantages that print journalists have is that they learn document design on the job. Today, thanks to computers and design packages, design awareness is very high. Even the novice computer user becomes proficient in designing documents within a few days, if not weeks. Usually, templates are available for brochures, reports, books, etc. All you need to do is fill in the contents in the readymade template. Kamath, Gurudutt R. IT People (2003). Articles>Document Design>Document Design>Visual Rhetoric 7. #22596 Gurudutt Kamath's columns on technical writing. Groups for technical writers in India. Indexing, Translation, resources for technical writers. Kamath, Gurudutt R. DocumentorG. Resources>TC>Mailing Lists>India 8. #24973 Columns on technical writing. Continuation of the column written from 2001-03 for IT People. Kamath, Gurudutt R. Topica (2004). Resources>Mailing Lists>Writing>Technical Writing 9. #22600 Estimating a Technical Writing Project How do you go about estimating the number of hours that a project would take? Kamath, Gurudutt R. IT People (2000). Careers>Consulting>Writing>Technical Writing 10. #22691 Don't you think that it is a tragedy that 95 percent of the people who desire to be technical writers have a poor command over the language? I am sure all of us make a mistake or two, once in a while. But to make it in every sentence and paragraph shows utter disrespect for readers. Kamath, Gurudutt R. IT People (2003). Articles>Editing>Grammar>Technical Writing 11. #22610 Growth Prospects for a Technical Writer Are there practical chances of growth and scope for learning/improving oneself while working as a technical writer? Kamath, Gurudutt R. IT People (2004). Careers>Writing>Technical Writing>India 12. #14637 13. #22599 'Localisation' is the term given to changing the software and the related documentation to suit a particular geographical region. One of the major components of localisation is of course translation. Needless to add, I am talking about localisation from an international perspective. Localisation at the national level would mean having software in Hindi, Marathi, Gujarati, and so on. Surprisingly, this has not happened in a big way. Kamath, Gurudutt R. IT People (2000). Articles>Documentation>Localization>India 14. #22598 Learn to Read Technical Writing! Why is my daughter not being taught to read technical literature? Practical things like reading a VCR manual or a pamphlet on health. Kamath, Gurudutt R. IT People (2003). Articles>TC>Writing>Technical Writing 15. #22690 Learning the Fine Art of Reviewing If you asked me what the most painful part of being a technical writer is, my answer would be: 'Getting reviews on time. Getting good feedback and inputs on your work.' For me technical writing has been very pleasurable because I hardly got any review comments. My morale has therefore been very high. Project managers, developers and others are so busy trying to come up with good software (read trying to fix all the goof-ups and bugs!) that they usually tend to give documentation lesser importance. User manuals, who reads them anyway? We do not have time for it! Kamath, Gurudutt R. IT People (2003). Articles>Editing>Collaboration>Technical Writing 16. #22608 When you are a speaker, you communicate. When you are the audience, you communicate. As a member of the development team, the technical writer has to deal with hundreds of intelligent egos. There are the programmers who think only about solutions and technology (not about people and their emotions). A technical writer would definitely feel hurt, when developers talk down to him. Managers on the other hand are likely to have oodles of people skills and may not have technical skills. Therefore, they may talk nicely to you. Nevertheless, a technical writer may feel that managers do not appreciate his technical skills. Kamath, Gurudutt R. IT People (2002). Careers>Writing>Technical Writing>Workplace 17. #22597 Some of the biggest opportunities in technical writing are in proposal and grant writing. In fact, an American company wanted me to write proposals for them. But I refused saying that I had no experience. Of course, I lost money and a “golden opportunity”. You need not miss out on such an opportunity. If you know English and have some report writing skills, you can become a proposal writer. In India, grant writing or writing reports for grants or funding is not very popular. But in the US grant writing is big business. Technical writers are making big money writing grants and proposals. Typically, departments in universities want funding for their projects. These could come from corporations, trusts, and individuals. How do you convince them to fund your projects? That is what grant writing is about. Kamath, Gurudutt R. IT People (2000). Articles>Grants>Proposals>Writing 18. #22602 We are all against bonded labour and slavery. I ask you: are software professionals (including technical writers), better off than slaves and bonded labourers? Kamath, Gurudutt R. IT People (2003). Articles>Documentation>Project Management 19. #26057 One Cannot Live by Salary Alone Once our profession is known outside IT, the scope for technical writers will grow in geometric proportions. Clearly, there are good times ahead. Kamath, Gurudutt R. Indus (2005). Careers>Salaries>Statistics 20. #24184 One Hundred and One Technical Writing Links A few links to websites helpful for technical writers. Kamath, Gurudutt R. DocumentorG (2007). Resources>Directories>Writing>Technical Writing 21. #22687 One Hundred Simple Tech Writing Errors Here are the 100 writing errors that the author has encountered in his experience. (Followed by the subsequent article 'Ten More Errors in Technical Writing.') Kamath, Gurudutt R. IT People (2003). Articles>Editing>Grammar>Technical Writing 22. #22606 Recruiting Spree for Technical Writers I had a chance to interview three technical writers in Pune, the oasis of technical writers. All of them were techies doing technical writing. I am into EDA technical writing these days (one of the toughest areas of technical writing—this is rocket science, buddies!) and naturally technical acumen is a strength. All of them were new to technical writing (and perhaps even writing) as was evident from the fact that none of them brought in writing samples. Kamath, Gurudutt R. IT People (2003). Careers>Writing>Technical Writing>India 23. #22692 Technical Writers' Mailing Lists The TWIN (Technical Writers of India) mailing list has crossed 1,000. As the founder and owner, I wanted to stop the list a few years ago when it had touched 675, because I was afraid it would touch 1,000 within a few months. I had other reasons for wanting to stop the list. But the voice of the members prevailed and I handed over the list to the current owner. Why did I start the list? Well, I saw that Indian technical writers (and others), were making a fool of themselves on Techwhirl (a list with around 4,000 members then, today perhaps it has 8,000) and other lists. A professor from a reputed institute in Bangalore had asked about a problem of printing on the list. I was embarrassed. I said, why not restrict this ignominy to ourselves and started the TWIN list. Kamath, Gurudutt R. IT People (2003). Articles>Writing>Mailing Lists>Technical Writing 24. #23412 The reason for the relatively low number of technical writers in India is because India has been concentrating mainly on doing projects. It is only in recent years that many top multinationals have set up their development factories here. This has dramatically increased the technical writers' population in India. In some companies in Bangalore and Pune, one gets to hear of teams of 10 and 20 technical writers. Otherwise, India is no different to other countries: a large number of technical writers work alone in their companies. Today, all these technical writers have come together to share information and ideas through TWIN, the Technical Writers of India mailing list. Kamath, Gurudutt R. TC-FORUM (1999). Articles>TC>Regional>India 25. #22688 Ten More Errors in Technical Writing So, well, here are 10 more errors. This time we will focus on grammar and punctuation. Most of these are simplistic and obvious. But then they are too common. As usual, I have slipped in some content for the advanced writers too. (This article is a follow-up to 'One Hundred Simple Tech Writing Errors .) Kamath, Gurudutt R. IT People (2003). Articles>Editing>Grammar>Technical Writing
| |||||||||
| |||||||||
Click here to learn how to embed the RSS feed by this author in your website.