- http://www.promana.net/qualities-needed-to-be-a-strong-project-manager/
- http://analogperceptionz.blogspot.com/2011/06/are-you-qualified-to-be-project-manager.html
Hi, I am Anuj Kapoor and this blog allows me express my views on technical writing. Through this blog, I want to provide my readers with the information that they may find it useful in the field of technical writing. And, if it does, feel free to write to me at anuj.anujkapoor@gmail.com.
Tuesday, June 28, 2011
“You fuck them, you kiss them”
Wednesday, December 8, 2010
Have I misused something? - Commonly used confused words in technical writing – Part I
- http://homepage.smc.edu/reading_lab/words_commonly_confused.htm
- http://www.wsu.edu/~brians/errors/errors.html#d
Thursday, December 17, 2009
Bidding Good Bye to the year 2009!
Let's ring in the new year
with good things in mind
Let every bad memory
that brought heartache and pain
And let's turn a new leaf
with the smell of new rain
Let's forget past mistakes
making amends for this year
Sending you these greetings
to bring you hope and cheer”
These are some of the wonderful lines from a beautiful poem that I found while I was searching the Internet. Yes, it is true that the year 2009 is about to end, and the countdown has just begun. We have just few days before the year 2009 will hand over the baton to the New Year, 2010. Everyone must have some very good and few bad memories in the year 2009. So, let’s just forget the bad ones but just let us just ensure that we won’t commit those again in the New Year. So, what is it that we can do to ensure that we as Technical Writers can do better in this industry, and be upbeat with others? Is there any mantra to succeed, and have a dream job? What is the kind of job that we should look forward to in the New Year? These are some of the questions that you must be wondering while you are bidding farewell to the year 2009, and that whether the New Year will be good for the Technical Writing market. There are few things that you can do in any situation to have a dream job. Let us discuss some of them in this article.
1. Go networking!
Network! Network! Network!
This is the new mantra now for getting hired as a technical writer. And, by network, I don’t meant to say LAN, WAN, and MAN.. ..What I mean to say is that you need to join a social networking group in Technical Writing. Though, there are so many such groups available in LinkedIn, TWI, TWIN, and so on. But, it is you who have to decide which to choose from. Of course, the best one up till now is STC because it gives you an opportunity to interact with technical writers around the globe. It might consume your time when you busy with your work pressure and meeting deadlines. But, lest ensured, it will reap you results sooner or later. By networking, you might not get hired in your dream job but it will definitely give you a chance to expand yourselves as you will come in contact with many people, which will help you in your career growth. And to add to it, these social networking groups also include many reputed employers.
So, Go Networking from the day ONE of the New Year. Join a Technical Writing social networking group.
2. Jack of all, and master of ONE
You must have heard of this phrase many times now. But what is really means is that you need to master in one tool that you have been using throughout your career, and become an expert. But, at the same time, you need to gain some knowledge and hands on experience on almost all the major tools that technical writers use. Of course, you might be wondering that how is it possible to learn each and every tool when there are so many tools available in the market. But, you can at least learn those tools that are the most demanding ones in the market.
So, Master one tool but become a Jack of all the tools.
3. Build your resume
In order to have your dream job, you must create your resume in a manner that it impresses the employers first hand. And, to do this, you must include some of your best projects that you have undertaken throughout your career. Do not forget to include the following things while including the project details:
- Project name
- Project description
- Client you worked on for the project
- Domain that you worked on
- Skills / tools you used in the project
- And most importantly, the role you played in the project and the team size.
Though, you might be working as a technical writer; but, you also need to ensure that you always stay ahead of the others as the skills sets change continuously. For instance, today you might be working in Framemaker but tomorrow there might be some other tool in the market that may become a “Hot” requirement for employers. So, you need to just take time out to find out the latest tools and techniques used in technical writing. As I said earlier, you can do this if you have joined any social networking groups such as STC or TWIN. You need to subscribe to any industry magazines where you can find any specific specialty such as software, hardware, or engineering. You must learn on the latest tools, and get yourself equipped with latest technologies in technical writing otherwise you might just fade away.
5. Get yourself acclaimed
Start the New Year by getting acclaimed in whatever you do whether it is into writing an article for a newsletter or volunteering for a position in a social networking group. Getting acclaimed might not necessarily find you a dream job but it will definitely give you a sense of satisfaction. Rather, it will also put you in contact with professionals in your field who can recommend you, and give you advice about companies and the career paths that you can choose from. Volunteer for a position that you feel it’s appropriate for you. For example, you can choose to interview a renowned personality whom you feel has brought laurels to the field of Technical Writing, and get it published in a magazine. You can also become a design a layout of a newsletter or a magazine if you are really creative or join a coordinating committee in a social networking group to organize various meet-ups, workshops, seminars, and so on technical writing.
6. Master the Interview
Job Interviews are arduous and it’s hard to match with the requirements of the interviewer. But, we can at least try our best by remembering the basics and stay confident in what we do at the present. These days, most interviews happen over the telephone so we will not know the facial expression of the interviewer. So, here we are with a drawback while facing an interview. The key lies in to believe in one self, and do not ever lie or amplify your skills. You should stay positive about your abilities. Remember, if you stay honest then you may get your dream job as compared to when you are dishonest with the interviewer.
Conclusion
Let us just summarize whatever we have discussed so far
1. Go networking!
2. Jack of all, and master of ONE
3. Build your resume
4. Stay ahead of the rest, and be qualified
5. Get yourself acclaimed
6. Master the Interview
While, there is no sure shot way to get a dream job as a technical writer but the things we discussed will get you at least closer to your dream job. If you apply these methods in the year 2010, then it might increase your chances to succeed in the career of technical writing.
Friday, March 27, 2009
Domain knowledge: Is it essential for technical writers and content developers!
A lot is talked about how domain knowledge is essential for technical writers in today’s industry. Before even we go into detail into why is it important, let us first understand what you mean when you say “Domain Knowledge”.
A standard definition of Domain knowledge is that it is knowledge about the environment in which the target system operates. It is critical for a technical writer to acquire knowledge about a particular domain because a technical writer often acts as a bridge between the end-users and software developers. A Domain is generally defined as an area of interest or an area which you are communicating about. A domain is also defined as a particular environment that you are already working in or interested to work.
As a technical writer, you are required to understand the market specifics that vary from different geographies. You need to understand the overall trends in the market, as well as technology and economic trends that could impact product performance, who are the competitors, what are their strengths/weaknesses, and where are they heading. All this information and much more constitute to “Domain Knowledge”. But, you must be wondering in your mind, why at all it is essential to gain domain knowledge when you have Subject Matter Experts (SMEs) to do the job for you. As a technical writer, your job is to develop documentation for the software. The rest shall be left for the SMEs to validate it. Then, why has it become so essential today to gain domain knowledge?
Agrees Mohan Babu K. in his article that business domain knowledge is extremely important particularly in an offshore environment.
So, gone are the days when you were just writing just for software. Today, at one stage when you are writing for software and on the other, you would be also writing for a financial institution.
Why Domain knowledge?
Acquiring knowledge of a domain always helps you to add variety to your profile. It adds some spice to your resume. It is better when you acquire knowledge in more than just one domain. There are various business domains where you can acquire knowledge on such as:
- Finance
- Human Capital Management (HCM)
- Telecom
- Retail
- Industrial & Distribution
- Electronics / Semiconductors
- Medicine
- Biotechnology
- Banking
- Engineering
- Aviation
- Building & Public Utility
- Consulting/Professional Services
- Defense
- Educational Institutions
- Shipping
- Government
- Hardware and Software
- Healthcare
Knowledge of a particular domain (s) is considered as a secondary requirement for any job opportunity of technical writers. The first and foremost requirement is to write clearly, and an ability to grasp the new concept (s). So, if you have this ability to grasp any new topic or domain, you can do a wonderful job as a technical writer. Thus, I feel that Domain knowledge is not a primary requirement for technical writers. Knowledge of a domain helps you to interact with the SMEs in a better manner thereby fortifying your interpersonal relationship within the organization. It also gives a confidence among your client who feels a sense of satisfaction when you are able to understand what the client is trying to say. It happens sometimes, when a client speaks about a concept and you are not aware of. But, if you have knowledge of the subject being spoken about by the client, this gives a level of confidence to not only the client but to you even. In other words, remember the golden rule, “Domains stay but the technologies change thereafter.”
Once upon a time...
So, the Project Manager used to work 24 hours a day and seven days a week, and he was dedicated to his job. He had already been a recipient of many “Star Employee” awards in the company. Let me tell you about his personal life. He was married and had a good-looking wife. He also had a 6-year old son who went to a private school. But, since the Project Manager was always dedicated to his work…so he didn’t even had time to know about his child’s well being. Moreover, what class he has been into and he don’t even noticed his child’s first walk. Therefore, one day, when finally, he had nothing to do at office, he decided to go home a little early. That was a surprise for some of the people working in the company, and some even saw him in amusement. But, finally the day has come when he decided to go early. Therefore, he called his cab and asked the cab driver to drop him early today. When he reached home, a six-year old boy (who was his son) opened the door who failed to recognize his own dad and asked him, “Who are you?” The boy then went to his mother, and said, “There is someone on the door whom I don’t know”. His mother came running to the door, and first felt surprised, and then felt a little angry. Surprised because her husband has come before even his usual time, and angry because her son had failed to recognize his father. But, she didn’t express her anger to his son; instead, she looked at her husband and just gave an indication with her eye like it saying, “Look, your son don’t even recognize you”. That was the most embarrassing moment for the Project Manager because his own son didn’t even recognize him as his father. He didn’t say a word to his wife or to his son. He quietly stepped inside the house, and went to his room. Then, he closed the door and locked it from inside. He then took out his family album which he didn’t have time to take out all through these years.
At least, we have an advantage to watch our past through the photographs which makes us realize that what we have missed and what we have done.
The Project Manager quietly kept turning the pages of the album, and saw the moments that he had missed, the moments that he could cherished, the moments that were much better than those awards and trophies which he won in the company, the moments that he could have enjoyed while he was busy bringing profits for his company. He kept on turning pages of the album, and with each page turned; a drop fell from his eyes making him realize of the fact that he has missed so many cherishing moments. Then, finally, he came to picture where he saw his son with a trophy, which was not similar to one he had received in the company because it was much smaller. But, he was happy that his son too had won a trophy but sad that he wasn’t there to enjoy and celebrate the moment. Finally, the album ended, and he made up his mind; that was the end of the day. Because from there on, he will be a refined person and he vowed to himself that he will come early and spent time with his family, which includes his wife and his son and enjoy every moment. He wiped his tears, and opened the door with a smile like he had just been born or like a doctor opens a door when a child is born showing signs of happiness. He then sat down to have dinner with his wife and son…and listened to his son’s wildest things, and enjoyed them.
The moral of the story is that “Work but in between also do not forget to spent time with your loved ones..your family, your family may include anyone, such as wife, son, mother, father, or anyone else….because they need your time more than your money. Money can be earned but not TIME because it is time that’s precious and not MONEY…TIME is more precious than thousands of diamonds because once you lose it…you are left with only memories and nothing else.
Am I a “Good” Writer?
Tips and Techniques
Here are few technical writing tips/techniques to differentiate between good and bad writing.
- THINK BEFORE YOU WRITE: As a technical writer, it is essential that you must think before you start writing a document whether it is a user manual, a proposal, or any training manual. It is extremely important that you must analyze a product, process, and procedure that need to be documented. You must first understand yourself clearly what you are writing about. It is as good as saying that “Put yourselves in your audience’s shoes”. Think how your audience will react to the product or a system. As a technical writer, you must consider yourselves as an "advocate" for the user, which means that you explain a system clearly from the audience’s perspective, anticipating the questions and problems of an average user. In this way, you may even provide suggestions to the system or procedure while is in the design phase.
- KISS: The word "KISS" means, keep it simple and stupid. When I say simple and stupid, what am talking is to keep your document simple and you should not make use of drawn out and complex sentences in the document.
- “ALWAYS FOLLOW THE TASK-BASED METHODOLOGY”: I found this heading from a website, and found it interesting. Now, you must be wondering what this “task-based approach” is. Consider a scenario where you got a host of information from a team of developers / programmers, and now you begin your phase of writing. While you documenting (user manual, training manual, or any proposal document), you might confuse yourselves to put all these details and give a proper shape. Thus, you must follow a task-based approach which means that you should always break a particular concept into different tasks. This will affect in structuring your document properly. A task-based approach allows you to analyze what tasks will the audience of your document want to perform. This will help you to benefit in terms of organization, readability and usability of a document. For example, consider a scenario where you wish to write a user manual for MS Word. For this, you should first describe how to start MS Word, create a new document, print a document, and work with a document and save the document. However, some of the technical writer might not agree with me as they would feel that a structured-based approach will be definitely a good option to write a document. It is certainly not wrong to use a structured approach as it is also essential to include structural information if your document is to be complete. However, you must understand from the audience’s perspective that an audience always wants first of all to accomplish a task, and then find out about the unessential details.
- AVOID USAGE OF PHRASES IN TECHNICAL DOCUMENTS: As a technical writer, when you should keep a document simple and sweet, it also becomes essential to avoid any usage of phrases in your document. These phrases may complicate a sentence and may even prove to be dull and boring. For example, you mustn’t use phrases such as “afford an opportunity to”, “in view of the fact that”, “prior to”, “with reference to”, and “for the purpose of”. Instead, you should use simple words such as allow, because, before, and about which have the same meaning but have a soothing effect to the audience.
- ALYWAYS MAKE USE OF ACTIVE VOICE: While you are writing a document, always remember to use active voice instead of passive voice. This makes your document interesting to read and even helps you to avoid using any lengthy sentences. Active voice usually is shorter and more direct than a passive voice, which is more complicated and lengthy.
- AVOID VERBOSITY: This is the most common tip that you may find in most of web sites. Verbosity means long-windedness, which means that you must not tell the audience about how much you know about a product or a system. However, you should understand how your audience will understand your document. For this, always remember to keep your sentences in a document as concise as possible. Keep your sentences crisp and make it interesting to be read.
- ORGANIZE USING HEADINGS: It is always said that a “heading” often summarizes a particular section for what you want to say to the audience. A heading may allow your audience to browse your document, and even skip certain sections that might not of immediate interest to the audience. Thus, it becomes utmost essential to organize your document with proper headings such as “Creating a Document”, “Saving a Document”, or “Closing the Application”. In addition, it is also recommended to use a “gerund” form while writing your headings. A gerund is a verbal that ends in -ing and functions as a noun. The term verbal indicates that a gerund, like the other two kinds of verbals, is based on a verb and therefore expresses action or a state of being. A heading should not also mislead an audience. It should clearly depict the contents of that section.
Mentoring Technical Writers!
If anyone of you is willing to learn technical writing, do contact me at my email: anuj.anujkapoor@gmail.com.