Re: Code Annotation of the Week

Subject: Re: Code Annotation of the Week
From: Bill Swallow <techcommdood -at- gmail -dot- com>
To: John Posada <jposada99 -at- gmail -dot- com>
Date: Wed, 11 Nov 2009 13:50:11 -0500

Certainly I can't be the only one snickering at the thought of an
error message being documented as part of a procedure. ;)

1. Do X.
2. Do Y.
An error message appears. Click OK.
3. Cry.

On Wed, Nov 11, 2009 at 1:38 PM, John Posada <jposada99 -at- gmail -dot- com> wrote:
> As that message didn't give any information other than words, I'd
> refer to the mesage in generic terms, something like "An error message
> appears...." Nothing is defined by the words of that message that
> couldn't be addressed by being generic..

--
Bill Swallow

Twitter: @techcommdood
Blog: http://techcommdood.com
LinkedIn: http://www.linkedin.com/in/techcommdood

Available for contract and full time opportunities.

------------------------------------------------
STC Ideas: http://stcideas.ning.com
Join: http://stcideas.ning.com/?xgi=6X1vNGI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help and Manual 5: The all-in-one help authoring tool. Full support for
team authoring with multi-user editing - both directly and in combination
with VSS-compatible source control systems. 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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Re: Code Annotation of the Week: From: Robert Lauriston
Re: Code Annotation of the Week: From: Keith Hood
Re: Code Annotation of the Week: From: Robert Lauriston
Re: Code Annotation of the Week: From: John Posada

Previous by Author: Re: Figures with numbered callouts
Next by Author: Re: And since were on about snagit today, here's an easier way to tweet with snagit;
Previous by Thread: Re: Code Annotation of the Week
Next by Thread: Re: Code Annotation of the Week


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

Sponsored Ads


Sponsored Ads