Merry Christmas Folks! Have a great holiday season and a terrific new year. :-)
Write to me: Suman[at]sumankumar[dot]com
Write to me: Suman[at]sumankumar[dot]com
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 programmers and managers seem to think that if they understand it, so should the user. It doesn't matter whether or not they do… they SHOULD! Stupid users! Maybe it's the geek's ultimate revenge…
Your document can be 100% accurate, but if the audience can't read it, you've wasted your time.
Important in SI:
God I hate writing help files. I'll never be able to be a technical writer. How do those people do it? There are actually technical writing sites that are devoted to the love of the profession. I seriously admire these people. It takes nothing but love and hard work to be good at this (much like C++..?). And all I'm trying to do is make a simple help file on The Regulator. Geez. You'd think I'd have done it by now, 4 days after starting, but no. I only have like one page and a basket full of chocolate wrappings(kidding... we're trying to have the least amount of chocolate available in the house, specifically for situations such as this). So. any suggestions? anyone else wants to help me write this thing? I promise a serious credit in the about :)(via rosherove)
To be honest, I've never had to do this before. Sure, I've written many technical documents, but documents that say “click this then you'lll see this so click that to get this” are simply ....ugh!
"Does this mean that the written "voice" is never spontaneous and natural but always an artificial construction of language? This is not a proposition that most writers could accept. The act of writing is personal; it feels personal. The unfunny person who is a humorous writer does not think, of her work, "That’s not really me." Critics speak of "the persona," a device for compelling, in the interests of licensing the interpretative impulse, a divorce between author and text. But no one, or almost no one, writes "as a persona." People write as people, and if there were nothing personal about the result few human beings would try to manufacture it for a living. Composition is a troublesome, balky, sometimes sleep-depriving business. What makes it especially so is that the rate of production is beyond the writer’s control. You have to wait, and what you are waiting for is something inside you to come up with the words. That something, for writers, is the voice."
Commandment: Test with a panel of typical users – Give the draft instructions, and any product associated with them, to a focus group of typical readers. Watch them trying to use the instructions. Observe any false moves they make. Discuss with them how they got on. Ask them about any misinterpretations. Redraft the instructions in the light of what you find.Ah!Usability testing of end-user documentation. How many of us do it?
Responsible for writing documentation to support our PowerAnalyzer and PowerCenter Connect product lines. PowerAnalyzer is a business intelligence tool that helps decision makers access, analyze, and share enterprise data. PowerCenter Connect products enable integration to ERP systems such as SAP and PeopleSoft, CRM systems such as Siebel, and messaging systems such as IBM MQSeries. As a Senior Technical Writer at Informatica, you will be required to write new manuals and update existing ones. You will be responsible for delivering high-quality printed manuals, online help, release notes, and webzine articles on time.