Posts Tagged ‘Technical Writing’
Technical Writing as a Career – An Introduction
(An informative and introductory article written by two Indian technical writers…) By Pradip Kumar Nath & Hemprabha Chauhan Technical writing, a form of technical communication, is a style of formal writing and is used in fields as diverse as computer hardware and software, aerospace industry, robotics, finance, consumer electronics and biotechnology. Technological Writers explain complex…
Read MoreTranslation and Localization in a Recession
by Nabil Freij GlobalVision International I’ve answered many calls recently from localization managers complaining that their budgets are being cut, asking for advice. If you are suffering from the same symptom, here are a few pointers to consider. Don’t panic! In a recession, it is normal to cut budgets in an effort to reduce costs.…
Read MoreTechnical & Copy Writing – How to Use Causality Correctly
Organize your writing so that it becomes very clear what kind of cause-and-effect relationship exists between different elements of your argument. LINEAR Causality A is the reason why B happens; B is the reason why C happens; etc. CORRECT WAY of using it: A: A previously-public land is rezoned for upper-scale commercial development. B: Land…
Read MoreTechnical & Copy Writing – How to Write “Hamburger emails”
You can use the “Hamburger Paradigm” of writing not only for technical articles and copy but for other types of communications as well, ranging from emails to criticism. In “Hamburger Communication” the principle is simple: sandwich your criticism in between two sweet layers of positive comment. This is sometimes also known as “1+1+1” or “2+1+1”…
Read MoreTechnical & Copy Writing – How to Write a “Hamburger”
“Hamburger Model” is a writing paradigm used in some schools and writing programs. It’s a quick and useful way of explaining how to organize the content of a typical non-fiction article, paper, or other kinds of similar prose. Think about the main parts of a juicy hamburger: Top bun, bottom bun, and whatever goes…
Read MoreTechnical & Copy Writing – How to Capture the Essence of a Topic
Capturing the essence of a topic is the heart and soul of good writing and editing. If you cannot tell what the main idea is, you cannot write it either. And if you cannot write it, how would you expect your readers to get it? So it all starts with you. Thankfully, it is not…
Read MoreTechnical & Copy Writing – How to Use Analogies
© Ugur Akinci If you draw out the parallel elements in seemingly different things you can establish analogies and write interesting articles. By drawing an analogy between two objects or processes you throw a fresh light on both. You thus create a new venue of evaluation that did not exist before. GOURMET COFFEE and FREE-LANCE…
Read MoreTechnical & Copy Writing – How to Use Gender-Neutral Language
© Ugur Akinci Whenever possible, avoid using gender-biased words and phrases. For example, instead of “Chairman,” you can try “Chair,” “Moderator,” or “Facilitator.” But if the gender of the “Chair” is obvious from the context, then you can use “Chairman” or “Chairwoman” as appropriate. Here are some other suggestions (inspired by Microsoft Style Guide): OLD…
Read MoreTechnical & Copy Writing – Be Consistent
Good writing is consistent writing, whether you’re writing a software manual or marketing copy. If you end your sentences with the same mood, voice and tense that you start them with, the battle is already won. [Which rule did this sentence violate already? Answer at the end.] VOICE If you start with active voice, end…
Read MoreTechnical & Copy Writing – Remember Your Audience
Write at the level of your audience. If you are writing a manual for electrical engineers, you do not need to explain what Ohm’s Law is. Actually, if you do, you may insult and alienate your highly educated readers. If, however, you are writing a children’s book or a general purpose newspaper article, you have…
Read More