Re: Bad documentation insanity of the day

Subject: Re: Bad documentation insanity of the day
From: Chris Borokowski <athloi -at- yahoo -dot- com>
To: Laura Lemay <lemay -at- lauralemay -dot- com>
Date: Thu, 29 Nov 2007 07:41:36 -0800 (PST)

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 -dot- 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
Re: Bad documentation insanity of the day: From: Laura Lemay

Previous by Author: Bad documentation insanity of the day
Next by Author: Quality documentation from the EFF
Previous by Thread: Re: Bad documentation insanity of the day
Next by Thread: 'Adobe PDF' problem with Word


What this post helpful? Share it with friends and colleagues:


Sponsored Ads