Bad documentation insanity of the day

Chris Borokowski athloi at yahoo.com
Thu Nov 29 08:41:36 MST 2007


I know many writers who struggle to avoid this, and its counterpart:

The "Set the Frame" dialog box allows you to designate the frame you
would like to use.

To set the frame, do the following:
 a. Enter the frame you'd like to set.
 b. Click OK.

I imagine legions of users sawing away at their wrists with plastic
rulers, out of pure frustration at this practice.

--- Laura Lemay <lemay at lauralemay.com> wrote:

> /* Sets the frame to the Frame frame */
> void SetFrame(Frame frame) {  ...
> 
> I see comments like that EVERY DAY.  sob.


http://technical-writing.dionysius.com/
technical writing | consulting | development


      ____________________________________________________________________________________
Never miss a thing.  Make Yahoo your home page. 
http://www.yahoo.com/r/hs


More information about the TECHWR-L mailing list