Best Programmers

  • Subscribe to our RSS feed.
  • Twitter
  • StumbleUpon
  • Reddit
  • Facebook
  • Digg

Thursday, 8 May 2008

Tech Writing Manager? So What?

Posted on 22:29 by Unknown
One of the 'tech writing managers' wrote on the TWIN list about this 'exclusive' Google Group he'd created for 'tech writing' managers. Here's what I wrote in response:

One of my very good friends runs a small software product company in Chennai. When I walked into his new office for the first time, I was stunned: plush interiors, air-conditioning, and a 'CEO' cabin! I was impressed.

I visited him again after a few months and noticed that he was sitting 'with' the team. The cabin was empty and I found a huge couch in the place of the Teak wood table.
The girl next to him was watching a movie. The guy next to him was chatting on G Talk. And our CEO stood up and ushered me into the 'cabin'. I asked him 'you don't sit here any more?' He smiled and said, 'I realized that if I sat 'with' them they'd feel I am 'one of them' and that's key to the success of an R&D environment.' I couldn't agree more.

I asked him, 'What's with that couch?' My friend's smile stretched till his ears as he said, 'When one of us are tired or spaced out, you know? We go and take a nap in that former CEO cabin.'

Bravo! I am sure you'll hear about him and his company very soon. There's no way this company can NOT succeed! Anyway...

I am just curious:

How are management issues different in technical writing? Management is management, right? You hire and manage people. You supervise project execution. Um, oh! you motivate people. You take the team to the next level. whatever that means? What else? Every manager, be it managing a snack bar in Domlur or a NASA lab, does that.

Don't you think you are flouting a key management principle by announcing your exclusivity to the green (and not so green?) world? I meant 'Work with them not 'on or away from them'

I could be wrong in assuming a whole bunch of things. Don't get me wrong! However, I'd appreciate a few responses: from ladies, gentlemen, and managers of the TWIN list. :-D

Come now, sense of humor is required for a manager. Especially tech writing managers.

Your thoughts?

Write to me: Sumank[at]gmail[dot]com
Read More
Posted in culture, management | No comments

Friday, 2 May 2008

Use it before you write it.

Posted on 03:51 by Unknown
From the Nikkor ED 80-400mm f/4.5-5.6D VR Review (emphasis is mine):
[quote]Here's the warning in the manual: "When the camera is pointed down, be careful not to hold the lens at the very end as indicated by the black marks in Fig. F, because the zoom ring or focus ring may rotate and pinch your fingers."

Huh? The camera doesn't have to be pointed down for this to happen, so I don't know what Nikon's crack manual writers were on when they wrote that. Worse still, your fingers will often be in that position because this is a heavy lens and you're likely to be trying to balance it by holding it near the front. The first time the camera racks focus on the lens from near focus to infinity at 80mm and your fingers are in the way, you'll get a rude shock as you think your fingers are about to be crushed by the receding front elements (at longer focal lengths, the front elements are further out and pinching is not likely). Fortunately, there's a small ramp on the bezel that tends to push your fingers out of the way, but it's still possible to get seriously pinched, especially if you have fat fingers.[/quote]

OUCH! Very rarely they read what we write and we get caught. So an embarrassed me quickly glances around, ensures no one's watching, and gets off the bus.

Write to me: Sumank[at]gmail[dot]com
Read More
Posted in hall of shame, manual, writing | No comments

Thursday, 24 April 2008

The Zoho CRM User Manual

Posted on 04:13 by Unknown
I admire and respect Zoho a lot. These guys walk their talk on usability. These guys adopted blogging and wikis with a vengeance and I am sure it is paying off.

So, when the cat called curiosity bit me, I downloaded their PDF manual. And, I am sad when I say this, I screamed in my head 'you too Zoho!?' I could see actual content only after 14 pages. That my friend is a sin. And, the bookmarks do not appear on the left-pane. It is bad enough that you offer PDF manuals: you don't zip them; refuse to tell me the size of the file or how long it'd take to download IN TO MY GODDAMNED BROWSER without my permission! Why can't people just zip the PDF! PDF is for print. Not for online consumption.

No, don't say 'everybody does it!' That is not the point. When you as a company set out, embraced, and made usability central to your product(s), why the hell would you treat your user manual like you would a homeless bum?

That said, Zoho's wiki-based documentation seems cool. But PDF... WHY!? gaawd! Why? For a Saas product that too!


Write to me: Sumank[at]gmail[dot]com
Read More
Posted in usability | No comments

Tuesday, 30 October 2007

My STC India Annual Conference 2007 Slides

Posted on 23:28 by Unknown
Contingency design does not figure much in conversations amongst technical communicators. In these conversations, the emphasis is usually on the almighty manual. However, oftentimes, customers read error messages before they even think of opening a product's manual. In this presentation, Suman Kumar introduces the key area of contingency design and answers questions like 'How do we design for contingencies?', 'Can you use error messages to boost customer experience and loyalty?', and 'How does effective contingency design help in reducing support costs?'

Find out:
Contingency%20Design.zip (2.28 MB)

Write to me: Sumank[at]gmail[dot]com
Read More
Posted in contigency design, error messages | No comments

Tuesday, 21 August 2007

I will be talking at the STC Annual Conference in Goa

Posted on 01:29 by Unknown
Contingency design does not figure much in conversations amongst technical communicators. In these conversations, the emphasis is usually on the almighty manual. However, oftentimes, customers read error messages before they even think of opening a product's manual. In this presentation, Suman Kumar introduces the key area of contingency design and answers questions like 'How do we design for contingencies?', 'Can you use error messages to boost customer experience and loyalty?', and 'How does effective contingency design help in reducing support costs?'
Read more on the STC Website.

Another interesting paper is by Rachna and Shilpa of Cadence: Test plans as a source of improving documentation quality.

Sweet.

Write to me: Sumank[at]gmail[dot]com
Read More
Posted in conferences, contigency design, stc | No comments

Wednesday, 1 August 2007

Citibank Online Banking: Bad Example

Posted on 03:19 by Unknown
There's a service called RTGS in Citibank. If you have a Suvidha account and you use the online facility, chances are, you must have seen it on your screen. Now, here's an example that borders on stupidity. The Citibank website says:
RTGS transfers allowed only for amounts between Rs 1,00,000 to Rs 2,00,000
Please do not include spaces or characters. For example, Rs.7,800.00 should be entered as 7800.00

Did you say 'So, what's wrong with that example?' Hmm?

Write to me: Sumank[at]gmail[dot]com
Read More
Posted in usability | No comments

Saturday, 23 June 2007

How often...

Posted on 04:00 by Unknown
...have you clicked OK without reading the message?

Write to me: Sumank[at]gmail[dot]com
Read More
Posted in contigency design, error messages | No comments
Newer Posts Older Posts Home
Subscribe to: Posts (Atom)

Popular Posts

  • Use it before you write it.
    From the Nikkor ED 80-400mm f/4.5-5.6D VR Review (emphasis is mine): [quote] Here's the warning in the manual : "When the camera is...
  • Participative Help Design
    Participative Help Design I used a weblog script to create online help for -uh- using weblogs. I used a plugin to pull help topics as alphab...
  • 3rd STC Chennai Meet this sunday.
    3rd STC Chennai Knowledge Sharing Session this sunday, April 4th. This month's knowledge sharing session will be held this coming sunday...
  • Firefox: Tech writer friendly!
    Firefox has an in-built popup blocker. Firefox saves your screenspace through its tabbed-browsing feature. Firefox allows for opening mult...
  • Engrish!
  • Context Sensitive 'Sticky Notes': Stick a Sticky Note to your Blog!
    Conceptworld's Quick Notes Plus might appear like any other Sticky Notes Plus (QNP) program, but its context-sensitive notes feature is...
  • Writing SI units and symbols
    Quite a few of us do not write the SI units correctly. If you are a Physics or Chemisty student, and still remember what you studied in scho...
  • Finding the voice
    Excerpt from LOUIS MENAND's review of Eats, Shoots & Leaves: The Zero Tolerance Approach to Punctuation” (Gotham; $17.50), by Lynne ...
  • The Personable Manual
    Why do product manuals sound formal and stiff-upper-lipped? Why don’t users read manuals? These questions have haunted the hallowed precinct...
  • Tech-writers – A Necessary Evil
    In a world where accuracy is all important, a lot goes over the head of the dummy. I don't know if it's intellectual snobbery, but p...

Categories

  • conferences
  • contigency design
  • culture
  • design
  • error messages
  • google
  • hall of shame
  • ideas
  • management
  • manual
  • standards
  • stc
  • strategy
  • tools
  • usability
  • writing

Blog Archive

  • ▼  2009 (1)
    • ▼  February (1)
      • The Personable Manual
  • ►  2008 (5)
    • ►  November (1)
    • ►  September (1)
    • ►  May (2)
    • ►  April (1)
  • ►  2007 (7)
    • ►  October (1)
    • ►  August (2)
    • ►  June (1)
    • ►  March (1)
    • ►  January (2)
  • ►  2006 (10)
    • ►  November (2)
    • ►  October (3)
    • ►  September (1)
    • ►  August (3)
    • ►  June (1)
  • ►  2005 (17)
    • ►  December (2)
    • ►  November (1)
    • ►  October (3)
    • ►  September (2)
    • ►  August (3)
    • ►  June (2)
    • ►  May (1)
    • ►  April (2)
    • ►  February (1)
  • ►  2004 (32)
    • ►  December (4)
    • ►  November (1)
    • ►  October (3)
    • ►  September (3)
    • ►  August (2)
    • ►  July (5)
    • ►  June (3)
    • ►  May (1)
    • ►  April (5)
    • ►  March (2)
    • ►  February (1)
    • ►  January (2)
  • ►  2003 (42)
    • ►  December (2)
    • ►  November (3)
    • ►  October (1)
    • ►  September (3)
    • ►  August (7)
    • ►  July (2)
    • ►  June (1)
    • ►  April (4)
    • ►  February (4)
    • ►  January (15)
Powered by Blogger.

About Me

Unknown
View my complete profile