
Most of you might have heard people speculating “What this technical writing is???”
Do you think it is a rocket science??? Well, not really….
Technical writing, a form of technical communication, is simply about putting technical information into easily understandable language. It can help reader solve a particular problem that can be related to computer hardware and software, chemistry, the aerospace industry, robotics, finance, consumer electronics and biotechnology.
It should be kept in mind that 'Technical Writing' is different from creative and other types of writing in many ways. Technical writing can include presentation materials, training materials, procedures, scientific papers, user manuals, help files, SRS (Software Requirements Specifications), maintenance manuals etc. Being a technical writer, you can serve as a part of a team conducting usability studies to help improve the design of a product that still is in the prototype stage. You have to edit technical materials and oversee the preparation of illustrations, photographs, diagrams and charts. You must work not only with engineers or programmers but often must deal with quality assurance and marketing personnel.
Basically the term 'technical' refers to knowledge that is not widespread, that is more the territory of experts and specialists so it is not writing about a specific technical topic but about any technical topic of any domain.
The first rule of technical writing is "Know your audience." A Technical writer is challenged to write about highly technical subjects but in a way that a layman or a non-specialist could understand so you should write in a manner that is adapted to the reader‟s needs, level of understanding and background. Remember you are a go-between one group of people with specialized knowledge and another group with no knowledge. Let's put it in this way that “You should plan to write in such a way that even Grand dad can understand”
Technical writing isn't like other IT professions. You don't need to pass an exam or become certified. There's no terrible out-of-pocket expense in this field. Most of what you need to know you have already or you can get on your own!
You must posses the following individuality if you want to make it your career:
If you are a technical writer, don't forget that you are performing an extremely useful task in current market. In today's IT industry, a Technical writer is somewhat like a power transformer stepping down high power electrical current to less intense voltages. Thus, as a technical writer, you are helping people to utilize more fully the powerful computing technologies now available.
Things to be taken care off while writing:
Do you think it is a rocket science??? Well, not really….
Technical writing, a form of technical communication, is simply about putting technical information into easily understandable language. It can help reader solve a particular problem that can be related to computer hardware and software, chemistry, the aerospace industry, robotics, finance, consumer electronics and biotechnology.
It should be kept in mind that 'Technical Writing' is different from creative and other types of writing in many ways. Technical writing can include presentation materials, training materials, procedures, scientific papers, user manuals, help files, SRS (Software Requirements Specifications), maintenance manuals etc. Being a technical writer, you can serve as a part of a team conducting usability studies to help improve the design of a product that still is in the prototype stage. You have to edit technical materials and oversee the preparation of illustrations, photographs, diagrams and charts. You must work not only with engineers or programmers but often must deal with quality assurance and marketing personnel.
Basically the term 'technical' refers to knowledge that is not widespread, that is more the territory of experts and specialists so it is not writing about a specific technical topic but about any technical topic of any domain.
The first rule of technical writing is "Know your audience." A Technical writer is challenged to write about highly technical subjects but in a way that a layman or a non-specialist could understand so you should write in a manner that is adapted to the reader‟s needs, level of understanding and background. Remember you are a go-between one group of people with specialized knowledge and another group with no knowledge. Let's put it in this way that “You should plan to write in such a way that even Grand dad can understand”
Technical writing isn't like other IT professions. You don't need to pass an exam or become certified. There's no terrible out-of-pocket expense in this field. Most of what you need to know you have already or you can get on your own!
You must posses the following individuality if you want to make it your career:
- You need a degree -- or at least a great deal of experience in the field (or fields) about which you're writing.
- Obviously, you need to be able to write well. At a minimum, this involves having a good vocabulary and a strong command of grammar, spelling and punctuation.
- You need good people skills. Most of the time you have to deal with your supervisors, programmers and engineers and these people often don't have time to answer your questions but you must have the skills to organize time for communication and clarifying all your questions from them.
- Once you are done with collecting information, you must know how to organize the collective information. Arrange the information into a suitable order.
- You need excellent Internet and surfing skills.
- Fast and accurate typing speed can be a PLUS; as you often will be working on a deadline
- Word processor (usually Microsoft Word) and other software associated with publishing, such as Frame Maker or Adobe Publisher.
- Develop and write online help and online documentation using a software application, such as RoboHelp.
- Have some understanding of graphics, including the ability to work with pictures (resizing, changing color balance, etc.) and other design elements.
- Work onsite or with external printing houses to handle document production, CD duplication, packaging, etc.
If you are a technical writer, don't forget that you are performing an extremely useful task in current market. In today's IT industry, a Technical writer is somewhat like a power transformer stepping down high power electrical current to less intense voltages. Thus, as a technical writer, you are helping people to utilize more fully the powerful computing technologies now available.
Things to be taken care off while writing:
- Concentrate on having well structured documents while writing. The structure of an article plays a very important role in conveying your message accurately. It helps the readers in clearly understanding your points and building their interest in your document.
- Take great care with the spellings and the grammar. Develop an interest for the reader, don‟t make them get bored.
- Write clearly using simple words which your audience understands.
- Avoid too long sentences and unnecessary repetition.
- Never use passive voice where you can use active voice.
- Speak directly to the user.
- Maintain focus and only give information related to the task in hand.
No comments:
Post a Comment