Comments on: An Otherwise Good Experience Soured by Flawed Documentation http://www.gryphonmountain.net/2009/07/an-otherwise-good-experience-soured-by-flawed-documentation/ Technical Communication and Other Writing Topics, by Ben Minson Wed, 11 Jan 2012 04:05:49 +0000 hourly 1 http://wordpress.org/?v=3.0.4 By: Mike Starr http://www.gryphonmountain.net/2009/07/an-otherwise-good-experience-soured-by-flawed-documentation/#comment-333 Mike Starr Wed, 24 Mar 2010 13:49:19 +0000 http://www.gryphonmountain.net/?p=648#comment-333 More likely the case in this example is that the technical writer was *not allowed* to provide good documentation. More likely the case in this example is that the technical writer was *not allowed* to provide good documentation.

]]> By: Ben http://www.gryphonmountain.net/2009/07/an-otherwise-good-experience-soured-by-flawed-documentation/#comment-332 Ben Tue, 14 Jul 2009 00:48:14 +0000 http://www.gryphonmountain.net/?p=648#comment-332 Sheila, your comment addresses a topic I've been thinking about: the use of examples. Sheila, your comment addresses a topic I’ve been thinking about: the use of examples.

]]> By: Sheila Loring http://www.gryphonmountain.net/2009/07/an-otherwise-good-experience-soured-by-flawed-documentation/#comment-331 Sheila Loring Thu, 09 Jul 2009 20:32:40 +0000 http://www.gryphonmountain.net/?p=648#comment-331 I have to put a plug in for Madcap Flare documentation. Examples are provided for each task, and they're realistic. In fact, I've been in many a quandry that the examples addressed. Some of the help pages are fairly long, but readability is increased by sections you can collapse and expand. I have to put a plug in for Madcap Flare documentation. Examples are provided for each task, and they’re realistic. In fact, I’ve been in many a quandry that the examples addressed.

Some of the help pages are fairly long, but readability is increased by sections you can collapse and expand.

]]> By: Margherite http://www.gryphonmountain.net/2009/07/an-otherwise-good-experience-soured-by-flawed-documentation/#comment-330 Margherite Thu, 09 Jul 2009 18:57:31 +0000 http://www.gryphonmountain.net/?p=648#comment-330 Add to the list - no indication that the engineers or marketers knew how the customers were likely to use the device. The scary inference is that the router was designed without a set of use cases, and the problems go much deeper within D-Link's corporate psyche than a problem with technical communication. Add to the list – no indication that the engineers or marketers knew how the customers were likely to use the device. The scary inference is that the router was designed without a set of use cases, and the problems go much deeper within D-Link’s corporate psyche than a problem with technical communication.

]]>