Best Programmers

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

Friday, 21 November 2008

Promoting Document Usage: Taking a leaf out of Business Directories

Posted on 01:54 by Unknown
You can argue all day that you know a customer that reads your manuals but my point is that most don't. It is a blessing in disguise for most of us: we get away with some really sloppy writing. But if you honestly want to help your customers but don't want to incur support costs, here goes:

Don't talk to them about your cream. Talk about beautiful, flawless skin. Didn't get it? No problem. Most software vendors bundle documentation or at least provide documentation online. And, most think their duty ends there. It doesn't. If it did, explain why customers still call up your Support Desk for information; the same information that your manual offers.

The explanation to this predicament lies else where: Business Directories. I used to be a Sales Rep for Tata Press Yellow Pages in Chennai (they call it InfoMedia now). After publishing and distributing the directory to users (all homes with a phone), they ran a publicity campaign. The campaign was meant to educate users on how Yellow Pages can help them. "Looking for an Architect? Look under Architects category in Tata Press Yellow Pages" Or something like that. The success of the brand depended on people using the product.

Do you promote the usage of your product documentation? I know the answer. Most of you don't. So what should you do?

Talk to your marketing/sales and support folks and send periodic e-mails to your customers. "Did you know that the Deployment Guide can help you customize the interface?" Or "Want to integrate MS-Office with your_product_name_here? See the Office Integration chapter in the Deployment Guide."

Also:
1) Track the kind of support calls you've been receiving
2)Identify common issues
3) Address them in your documentation
4) Highlight the fixes in your usage mail campaign
5) Start from step 1 and keep iterating!

I said track support calls instead of 'take a survey' because I don't believe in surveys. Surveys are the equivalent of you asking your dinner guests 'Hope you liked the food!' The answer is always yes, unless you have a socially aberrant guest who'd say 'Yuk. That food sucks!'

Think about it.



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

Monday, 1 September 2008

Comics and Technical Communication

Posted on 23:39 by Unknown


As always Google breaks away and uses a comic strip to do a launch-promo for its - hold your breath - web browser! Ladies and gentlemen, say hello to Chrome.

Maybe, just maybe, comics can be used for Quick Start Guides? Place Mats?



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

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
Newer Posts Older Posts Home
Subscribe to: Comments (Atom)

Popular Posts

  • Finding the voice
    Excerpt from LOUIS MENAND's review of Eats, Shoots & Leaves: The Zero Tolerance Approach to Punctuation” (Gotham; $17.50), by Lynne ...
  • 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...
  • 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...
  • Style guides: Sacrosanct?
    How many times have you paused and reflected, ‘man, I know I am right, but the style guide does not agree…’? For example, some style guides ...
  • (no title)
    Next STC Chennai Meeting On March 7 : This will be the second knowledge sharing session. The first meeting was a wonderful success and we h...
  • Wanted: Sr Technical Writer for Informatica Corporation
    Location : Bangalore Corporate Headquarters : Redwood City, CA Contact : Thao Diep, tdiep@informatica.com Job Description Responsibl...
  • 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...
  • Comments System: Anyone Can Post Comments Now!
    Folks, I know some of you were irritated by the fact that you had to login (if you're a Blogger user) or post as Anonymous while posting...
  • A brand name gone wrong
    "Did you know that Heroin was originally a brand name for cough syrup? In 1874, German scientists developed a formula for a painkiller ...
  • Promoting Document Usage: Taking a leaf out of Business Directories
    You can argue all day that you know a customer that reads your manuals but my point is that most don't. It is a blessing in disguise fo...

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)
  • ▼  2008 (5)
    • ▼  November (1)
      • Promoting Document Usage: Taking a leaf out of Bus...
    • ►  September (1)
      • Comics and Technical Communication
    • ►  May (2)
      • Tech Writing Manager? So What?
      • Use it before you write it.
    • ►  April (1)
      • The Zoho CRM User Manual
  • ►  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