Tuesday, September 09, 2008

Ten Technical Communication Myths

Geoff Hart rips apart the myths in technial writing. Great post.

Improving technical documentation

Technical writers all over the world are debating on how new approaches and processes can dramatically improve the quality of the documentation produced.

A few suggest that Usability testing, even with limited resources, can add value to the documentation you produce. Other suggest moving documentation to the Web 2.0 model for ease of use and adopting agile documentation. There are people who cite Google's example of comic documentation when they released their new browser, the Chrome.

Daniel Brolund suggests User Guide driven documentation where a snippet of the user guide describing a new feature is prepared. This is an interesting idea in that the techncial writers get a chance to become involved in the documentation process at the initial stages of software development itself. Click here to read Daniel's post.

Friday, September 05, 2008

Comics as technical writing

Google while unleashing its new browser Chrome, has created another great stuff. It's a comic book about the browse.

Check it out at http://blogoscoped.com/google-chrome/2

Friday, July 18, 2008

Is Gmail safe?

I was left wondering with this question as I read the following articles:

Finding the name behind the gmail address

A Question of Programming Ethics

An introduction to Cloud Computing

Cloud computing is nothing but utilizing supercomputer power to perform complicated tasks over the Internet. (I understood this much thanks to Business Week.

The article says “Cloud computing aims to apply that kind of power—measured in the tens of trillions of computations per second—to problems like analyzing risk in financial portfolios, delivering personalized medical information, even powering immersive computer games, in a way that users can tap through the Web. It does that by networking large groups of servers that often use low-cost consumer PC technology, with specialized connections to spread data-processing chores across them.”

Express Computer throws more light by saying that “The key feature of cloud computing is that both the software and the information held in it live on centrally located servers rather than on a end-user’s computer.” “…The architecture behind cloud computing is a massive network of ‘cloud servers’ interconnected as if in a grid running in parallel, sometimes using the technique of virtualization to maximize compute power per server.”

“Clouds will become dynamic components of enterprise and research grids, adding an "external" dimension of business flexibility by enhancing their home capacity whenever needed, on demand,” writes Wolfgang Gentzsch in GridToday. He maintains that Grid computing will stay as they will become more cloud like. That, he says, looks promising.

Infoworld explains cloud computing with examples such as SaaS (software as a service), Utility computing, MSP (managed service providers), and Service commerce platforms.

What about security of data and the data centers? “SWIFT, a bank-transfer consortium, has announced plans to build a data centre in neutral Switzerland, so that data collected in Europe will not be stored in an American facility, where it could be subpoenaed by the United States government,” writes The Economist.

Links for Cloud Computing:
Wikipedia
New to grid computing - IBM

Wednesday, July 16, 2008

Modern classic in the making?

Like the greatest practitioner of the art, Thomas Mann, Daniel Kehlmann is a master of irony, deftly subverting the expectations of the reader, writes Daniel Johnson about Kehlman's novel Measuring the World. Read the article in The Telegraph.

Thursday, July 03, 2008

Create demos, online presentations with ViewletBuilder

While reading an STC newsletter, I found that folks at Oracle use a tool called Qarbon ViewletBuilder. This was a piece of news for me. After a bit of browsing, I found that the tool can be used to create online presentations, demos, and e-learning modules. Callouts, notes, and audio content can also be added to online presentations created with this tool.

My favourite tech blog Labnol (http://labnol.blogspot.com/2005/06/qarbon-viewletbuilder-imagine-power-of.html) says that technical writers untrained in Macromedia Flash authoring environment will find this tool very easy to create Flash presentations. With the ViewletBuilder, all you have to do is to simply move the cursor over the screen captured. The Flash tutorials or simulations created with this tool can be easily previewed. The tool enables your presentations and demos to reach a wider audience than before.

ViewletBuilder works only with Windows and Linux.

Tools for technical writing

Adobe FrameMaker – Adobe FrameMaker 8 software is a powerful authoring and publishing solution for technical communicators and an essential upgrade for existing FrameMaker users who want to author and publish technical documentation in multiple languages, says Adobe. It supports Unicode, rich media, DITA and single sourcing.

RoboHelp - The most sought after Help authoring tool (HAT). RoboHelp 7 now supports Unicode, translational workflow, importing Word files, importing FrameMaker files and styles, user defined variables, and powerful collaboration.

Microsoft Word – Needs no explanation. Unstable for big documents.

Interleaf – Competitor of FrameMaker. Wikipedia says Interleaf provides an integrated set of tools for creating compound documents: word processing, graphics, data-driven business charts, tables, equations, image editing, automated page layout, book building-- including automatic index and table of contents, and conditional document assembly.

Arbortext - XML-based publishing system, says Wiki. It now supports Sharable Content Object Reference Model (SCORM) based eLearning.

WebWorks Publisher – Another platform for single sourcing the content created. Supports FrameMaker and Word. WebWorks includes pre-defined templates for 11 different output formats. It is not a HAT.

Adobe Illustrator- Vector based drawing tool.

Photoshop – Editing software for graphics.

SnagIt - An easy-to-use screen capture and editing tool.

Wednesday, July 02, 2008

Why editing cannot be just proofreading

Many people think that proofreading is just another word for editing. Some believe that it can be classified as another type of editing. They will argue that both essentially mean the same. It is unfortunate to see people from the publishing as well as the media industry holding the same opinion about the topic.

The only answer to the controversy is to put the facts straight.

The word “proof” in printing means a kind of a test sheet or draft that is checked for text and graphics and colors before going to the press or publishing. This proof is created after all the editing has been completed. The proof created is also checked for grammar, punctuation, and corrections are marked with standard proofreading marks. This “proof reading” can be termed as the last stage of the editing process. It is never a part of the actual editing process or copy editing.

Editing, on the other hand, starts the moment you receive the first draft or manuscript. If it is a document, it is checked for the content, organization, structure, unity, development of ideas, paragraph structure, etc. The document is checked to see whether it is complete in all its respects and whether it has clarity. It is also checked for the style, correct grammar, word usage, punctuation, citation, copyright issues, and impact.

To conclude, editing is a more in-depth process that looks at the completeness of the entire document. Proofreading is more of a mechanical process that checks the spelling, grammar, and punctuation.

Wednesday, June 18, 2008

Basics of computer languages

Machine Languages-The language of the CPU (The central processing unit of the computer, which does the "thinking"). The lowest level language, this is composed of 0's and 1's.

Assembly Languages-Abbreviations for machine language

High-Level Languages-Use program statements, words and algebra-type expressions. Developed in the 50's and 60's.

After a program is written in one of the high-level languages, it must be either compiled or interpreted.

A compiler program rewrites the program into language that the CPU can understand. A compiled program is generally considerably larger than the original.

An interpreter program translates the program statements into machine language one line at a time when the program runs. An interpreted program will be smaller than a compiled one, but will take longer to execute.

Fourth Generation Language (4GL)-Very high-level language. These are results oriented and include database query languages. There are fewer options for programmers, but the programs are much easier to write than in lower level languages. These too must be compiled or interpreted.

Natural Languages-5th Generation Languages-Not yet. Experts believe that in such a language statements look like normal sentences.

Monday, June 16, 2008

My list of idioms

This list does not explain common idioms.

Face the axe
An axe to grind
Achilles heel
Apple of somebody’s eye – A person or thing that is loved more than others.
Apple-pie (order)
To make amends
Up in arms – Ready to fight
Back to back – In succession
On the back burner
Bad blood between (A) and (B)
Blood and thunder – Violent and melodramatic acting in films…
Blood, sweat and tears – Extremely hard work
Draw blood
Bank on something/somebody – Rely on
Bear the brunt of –
Bear fruit – to bring out a result, usually a successful one
Bear on sb/something-
Beat
Tighten one’s belt
20. Tighten up on sth-to become more careful or strict
21. Walk a tightrope –
22. Blow one’s own trumpet –
23. To break the ice –
24. To bury the hatchet
25. To build castles in the air –
26. To take the bull by the horns –
27. Burn one’s fingers -
28. Cheek by jowl
29. Cock-and-bull story
30. To shed crocodile tears
31. To cry wolf
32. Cut short
33. Cut out for
34. Daggers drawn – Strained relations
35. Dead letter – a law or practice that is generally ignored
36. Turn a deaf ear
37. Die out
38. Dovetail – To combine together neatly
39. To eat humble pie
40. To take effect
41. Elbow room
42. Ex parte
43. Take exception to something
44. The exception proves the rule
45. Eyewash
46. To face the music
47. Full flat
48. To fall short of
49. The fat is in the fire
50. To play second fiddle
51. To fish in troubled waters
52. Flesh and blood – Human nature
53. To follow suit
54. Food for thought
55. Foul play
56. From hand-to-mouth
57. Hand-in-hand
58. To throw down the gauntlet
59. To get the better of
60. Gift of the gab – talent for speaking
61. To give in
62. To give a slip
63. To give full vent to
64. To cast a gloom over
65. Hand in glove
66. Ground
67. Grist to one’s/somebody’s mill
68. Hatch a plot
69. With a heavy hand
70. To wash one’s hands off
71. To haul over the coals
72. Herculean task
73. To hit the nail on the head
74. Hobson’s choice
75. Hocus pocus
76. In Hot waters – In trouble
77. To cut no ice
78. In a nut shell
79. In lieu of
80. Gordian knot
81. Once in a blue moon
82. Caught napping
83. To pay through the nose
84. Piece of cake
85. Pull the plug on sb/sth
86. A quirk of fate
87. Rankle with sth/sb – to cause bitter or angry feelings
88. Break the mould of sth –
89. Stick it out
90. Cleft stick
91. Big stick
92. Carrot and stick
93. Back the wrong horse
94. Take a stick
95. Give sb stck
96. a stick to beat somebody/something
97. The world is one’s oyster
98. Come to a bad/sticky end
99. Thin end of the wedge
100. Blind alley
101. Blind spot
102. Sheer away from something
103. Send somebody/something up
104. go through the pace
105. over the fence – unreasonable or unacceptable
106. Sixes and sevens
107. tooth and nail – Very fiercely, with all power
108. Splitting hairs – Disputing over petty issues
109. Strom in a tea cup
110. Sour grapes
111. Via media – middle way
112. Pin-head – a stupid person
113. Shoot your mouth off
114. …to the letter
115. keep to/follow the letter of the law
116. cry-baby
117. tittle-tattle
118. Chew the fat
119. goo-goo
120. grid-lock
121. hot-button
122. Smoking gun – indisputable evidence or proof as of a crime or misdeed.
123. down-shift
124. right-size
125. on-side
126. at someone’s beck and call
127. plug-and-play
128. open-collar job
129. mumbo-jumbo
130. pickled
131. put to the sword
132. Sword of Damocles
133. Neck of the woods
134. Bite the dust –
135. Bite sb’s head off
136. Bite off more than one can chew
137. In the pink of health/condition
138. Pink-eye
139. Shrinking violet
140. A yellow streak
141. The fat is in the fire
142. Fat of the land
143. Don’t get a wink of sleep
144. One-horse town
145. pick-out
146. run-down
147. snap-up
148. Bon-mot
149. Pull someone’s legs
150. Fill/fit the bill
151. Iron out something
152. Keep sb/so on tenterhooks
153. wishy-washy (pap, treacle)
154. slap-dash
155. chapter-and-verse
156. Hocus-pocus
157. poppy-cock (nonsense)
158. jim-jams – feeling of extreme nervousness
159. a throw
160. tick-off
161. get somebody’s goat – greatly irritate or annoy someone
162. whistle-blower
163. whistle-stop tour
164. hog the roads
165. cleave to
166. hard as nails
167. hard-boiled
168. hard-headed
169. hard-luck story
170. hard-nosed
171. butt in
172. quick on the uptake
173. harum-scarum
174. hot-potato
175. hot ticket
176. tack on
177. hatchet-faced
178. Read the riot act - Reprimand rowdy characters and warn them to stop behaving badly.
179. Know your onions - To be experienced in or knowledgeable about a subject
180. Stool pigeon - A decoy bird, or a police informer, or criminal's look-out or decoy.
181. True blue - Loyal and unwavering in one's opinions or support for a cause
182. Tuckered out – Exhausted
183. A sledgehammer to crack a nut -'Using a sledge-hammer to crack a nut' is using disproportionate force or expense to overcome a minor problem.
184. On the wagon - abstaining from alcohol. 'Off the wagon' - returned to drinking after an attempt to give it up.
185.

Friday, June 13, 2008

What is a defective verb?

For answers, please click here.

When to use commas to separate adjectives

Today, I had an interesting discussion with my colleague about the use of comma to separate adjectives. Finally, we decided to search the Internet for answers. This is what we got:

""When a noun is preceded by two or more adjectives that could, without affecting the meaning, be joined by and, the adjectives are normally separated by commas. But if the noun and the adjective immediately preceding it are conceived as a unit, such as little girl,' 'political science,' or 'glass ceiling,' no comma should be used." (The Chicago Manual of Style).

That settled everything.

Specific absorption rate

The term "specific absorption rate" is not from Physics or Chemistry. FCC defines it as the "amount of radio frequency energy absorbed by the body when using a mobile phone." Got it?

CNET has reviewed the SARs of all the leading mobile phone manufacturers and has presented a list of top 10 phones with the least SARs. Check it out.

Capitalization after colon

Should the first letter after a colon be capitalized or not? Is it an American usage or British usage?

LanguageLog replies to the accusation that the American usage is wrong by quoting examples.

Wednesday, May 28, 2008

Tips to speed up the PC

Check this link http://www.masternewmedia.org/news/2006/04/12/slow_computer_speed_up_your.htm to speed up the PC.

http://www.microsoft.com/atwork/getstarted/speed.mspx

http://www.speedupyourcomputer.windowsreinstall.com/index.htm

http://onecare.live.com/site/en-us/article/registry_cleaner_why.htm

My dictionary of words

power trip (n) Slang - An action undertaken chiefly for the gratification associated with the exercise of power over another or others.

Grok: verb (used with object) 1. to understand thoroughly and intuitively.
–verb (used without object) 2. to communicate sympathetically.(Dictionary.com)

deracination (n) deracinate (v): Uprooted, alienated from the native culture or environemnt.
Along with Afghan-American Khaled Hosseini, the Haiti-born Edwidge Danticat and Junot Diaz from the Dominican Republic, Lahiri swells a tide of new fictional voices: immigrants, who write about displacement and deracination. (The Independent)

Doodad: Ornamemtal attachment.
Tours have become a way to market the artist as a brand, with the fan clubs, limited-edition doodads, and other profitable products and services that come with the territory.

To bandy words: A phrase meaning to argue persistently.

Silver bullet (phrase): Direct and effortless solution to a problem.

garboil (noun): Confusion; turmoil.

tartuffe (noun): A hypocrite who feigns virtue, especially in religious matters.

asyndeton (noun): Omission of conjunctions, as in "I came, I saw, I conquered."

verbigeration (noun): Obsessive repetition of meaningless words and phrases.

The following words are from http://www.askoxford.com/worldofwords/newwords/?view=uk

abdominoplasty n. Medicine a surgical operation involving the removal of excess flesh from the abdomen.

bahookie n. Scottish a person's buttocks. origin 1930s: prob. a blend of behind and hough + -ie.

best of breed (phrase) any item or product considered to be the best of its kind.

blowback n. 2. chiefly US, the unintended adverse results of a political action or situation.

celebutante n. a celebrity who is well known in fashionable society.– origin 1930s: blend of celebrity and debutante.

crunk n. a type of hip-hop or rap music characterized by repeated shouted catchphrases and elements typical of electronic dance music, such as prominent bass.
adj. US, chiefly black slang (of a person) very excited or full of energy.
– origin 1990s: perh. an alt. past part. of crank1 or a blend of crazy and drunk.

hardscape n. chiefly US the man-made features used in landscape architecture, e.g. paths or walls, as contrasted with vegetation.– derivatives
hardscaping n.

hoody (also hoodie) n. · informal a person, especially a youth, wearing a hooded top.
– origin 1960s: of unknown origin.

mentee n. a person who is advised, trained, or counselled by a mentor.

mesotherapy n. (in cosmetic surgery) a procedure in which multiple tiny injections of pharmaceuticals, vitamins, etc. are delivered into the mesodermal layer of tissue under the skin, to promote the loss of fat or cellulite.

obesogenic adj. tending to cause obesity.

plank n. Brit. informal a stupid person.

radge Scottish informal n. a wild, crazy, or violent person. adj. wild, crazy, or violent. – origin 1920s: appar. an alt. of rage.

rendition n. 3. (also extraordinary rendition) (especially in the US) the practice of sending a foreign criminal or terrorist suspect covertly to be interrogated in a country with less rigorous regulations for the humane treatment of prisoners.

retronym n. a new term created from an existing word in order to distinguish the original referent of the existing word from a later one that is the product of progress or technological development (e.g. acoustic guitar for guitar).– origin 1980s: blend of retro- and -onym.

riffage n. informal guitar riffs, especially in rock music.

shoulder-surfing n. the practice of spying on the user of a cash-dispensing machine or other electronic device in order to obtain their personal identification number, password, etc.

SIPP n. (in the UK) a self-invested personal pension, a pension plan that enables the holder to choose and manage the investments made.

therapize or therapise v. subject to psychological therapy: you don't need to therapize or fix each other.

tri-band adj. (of a mobile phone) having three frequencies, enabling it to be used in different regions (typically Europe and the US).

twonk n. Brit. informal a stupid or foolish person.
– origin 1980s: perh. a blend of twit1 or twat and plonker.

upskill v. [often as noun upskilling] teach (an employee) additional skills.
· (of an employee) learn additional skills.

wedge issue n. US a very divisive political issue, regarded as a basis for drawing voters away from an opposing party whose supporters have diverging opinions on it.

Yogalates (also trademark Yogilates) n. a fitness routine that combines Pilates exercises with the postures and breathing techniques of yoga. – origin 1990s: blend of yoga and Pilates.

zombie n. a computer controlled by a hacker without the owner's knowledge, which is made to send large quantities of data to a website, making it inaccessible to other users.

Sunday, May 11, 2008

How not to teach database design

Techncial writers, please read this post.

I am of the opinion that users don't read 90 percent of the help files and user guides.

Any comments?

Tuesday, March 18, 2008

What to do when you get "Virtual Memory Low"

If you are using Windows XP, try these steps:
1. Right-click My Computer, and then click Properties.
2. In the System Properties dialog box, click the Advanced tab.
3. In the Performance pane, click Settings.
4. In the Performance Options dialog box, click the Advanced tab.
5. In the Virtual memory pane, click Change.
6. Change the Initial size value and the Maximum size value to a higher value, click Set, and then click OK.
7. Click OK to close the Performance Options dialog box, and then click OK to close the System Properties dialog box.
This is besides emptying the cookies, temporary files, and a system cleanup.

Send-up and parody

The word send-up is also used to mean parody.
It also means a literary or musical work in which the style of an author or work is closely imitated for comic effect or in ridicule. It also means a feeble or ridiculous imitation.
Related word is take off. Webster says "an imitation especially in the way of caricature."

Saturday, March 15, 2008

Tech stories rewind

Creative Docs .NET is a versatile vector drawing software on the lines of Adobe Illustrator or Corel Draw - the software is completely free for non-commercial use and also supports Windows Vista. Click for more

Thursday, January 24, 2008

Technical Writing in India: Miles to go...

"a substantial number got into the field without having a clear picture about the job they were supposed to do," said a survery conducted several years back.

I liked this particular observation because nothing much has changed for the better. Most of the product-based Indian companies do not have a proper technical documentation team. They are also unaware of the importance of technical documentation in marketing their products. Companies do not have guidelines or styles developed to suit their needs.

In the absence of credible data on how many Indian technical writers are writing technical documents from scratch and by testing software, it cannot be said that technical writing has arrived in India. Except for a few private training institutes, who make money in the name of training wannabe technical writers, techncial writing is not yet a lucrative profession in India.

When compared to the youngsters joining the media, the standard of English demonstrated by young technical writers in software companies is pathetic. Most of them have good oral communication skills, but when it comes to writing, they don't match high school students of English medium public schools in India. For many, technical writing is a shortcut to bigger things in the software industry.

A few technical writers can term themselves lucky, if their creativity and efforts are appreciated by both Indian and foreign clients. The remaining are still in the wasteland, with no original writing to their credit and for want of training in technical writing tools.

Those who want to make it big in technical writing should have interest in technology, software, programming languages, besides excellent skills in writing and editing. Otherwise, people are going to give a hell lot of trouble to others.

Books Update - Nov 2022

 Writing a post after a long time.  The following books were too boring and were queued for exchange: 1. The Wall by John Lanchester 2. Warl...