register | login
  search
Contact Us    News    Blog    Events    Careers    Customers    Employees
You are Here:  ResourcesBlog
Click Here to Get You Copy Today! MindTouch Most Influential Techcomm
 

Blog
23

Ripples in a pond: short-term savings, far-reaching results

Ripples on a pondKai Weber just posted a cautionary tale about what happens when a company regards technical communication as a task rather than as a profession.

In Kai's tale, programmers and testers are brought in from other parts of the company to help update a software product -- and then they're called on to write the documentation as well. The quality of the doc suffers, and customers complain that much of the doc focuses on features and reference information rather than on how to use the product.

Having given in to the "seduction" of reducing costs in the short term, management now finds that the product's documentation is hard to use and impossible to maintain.

Kai's story is all too true. I've seen it happen. Allow me now to write the next chapter.

After development and test assume the task of producing documentation, the effects move out like ripples in a pond to other parts of the company.

When customers complain that the docs are unusable, management asks the training staff (or a training consultant) to deliver courses for setting up and using the product. The cost of the training is borne by the company, which negates the earlier short-term savings, or it's passed on to the customers, which increases the cost of owning the product and makes the product less attractive in the marketplace.

A culture develops in which customers call on Tech Support to guide them through the setup and configuration workflow. Tech Support costs balloon while customer satisfaction sinks.

Kai's conclusions -- that writing effective documentation requires professional writers, and that "seductive" short-term savings end up costing more in the long run -- are on the money. I would merely add that the costs will end up permeating many different parts of the company and that some costs, like lost market share and diminished customer satisfaction, will go far beyond a simple P&L statement.

Have you ever been part of this story? If so I'd like to hear about it, and about the insights you gained.

About the Author

Larry Kunz

Larry Kunz is a project manager and information architect with SDI with more than 30 years’ experience as a writer, manager, and planner. He has experienced the transition from book-based documentation to today's integrated delivery of information both as a writer and a manager. Larry is a Fellow in the Society for Technical Communication (STC) and in 2010 received the STC President’s Award for leading the Society's strategic planning effort.


Posted in: Global Solutions
Recent Related Articles:

Is documentation the right word? - 4 : the usually printed instructions, comments, and information for using a particular piece or system of computer software or hardware (www.merri...

Upcoming webinar: Moving to XML - On May 23, I will be presenting this topic in a JustSystems Webinar. For those who are just starting to move to XML (DITA/XML is just dandy) or consid...

Welcome to the 60s - As I approach my birthday, I've decided to do something I rarely do. Look back at my career in technical communications to see what I've learned and m...

The burden of burdensome writing - This isn't meant to be a political statement but there is something interesting going on in NC right now. I'm not going to take a position one way or ...

It's about conversation. Let's converse! - The incredibly insightful Mark Baker wrote last week that it's time to change the "doctrine" of technical communication. You should read Mark's whole ...

« Back | |
Comments:
Kai
Tuesday, January 24, 2012 5:41 AM
Thanks, Larry, for continuing the story - in a most plausible and sad way... I agree, documentation done dismally will seep into other areas, again just like shortcuts in development or test will... It's just too horrid to imagine the futility and time and money wasted...
Larry Kunz
Tuesday, January 24, 2012 9:23 AM
Thanks, Kai. Thanks also for giving me the inspiration to write this post.

As the story unfolds, it truly does become horrid. Your use of that word invokes for me Heart of Darkness. Maybe we can call our story Heart of Doc-Lessness.
Kai
Tuesday, January 24, 2012 9:43 AM
Huh, Heart of Docless... I certainly like the ring and metaphor of that...

Previously around the tech comm watercooler, we've come up with Moby Dick and Camus' Sisyphos, something about imagining Ahab as a happy man as he rolls the white whale of documentation up the hill... :-)

... though the underlying management failure is actually too serious for such puns...
Post Comment

Name (required)

Email (required)

CAPTCHA image
Enter the code shown above:

    

Home  |  About Us  |  Services  |  Solutions  |  Resources
ISO9001 Certification NC & Budapest | privacy statement | terms of use | site map Copyright by Systems Documentation, Inc. | Follow us on Twitter Join us on Facebook Follow us on YouTube Link to us on LinkedIn