RE: Do you spellcheck Code Comments

Subject: RE: Do you spellcheck Code Comments
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2005 14:53:16 -0400


Always, always, always use correct spelling in the document.

Ask the developer if s/he wants a list of "typos" (not "mistakes" or
"errors"), so s/he can apply them to the code comments.

If s/he doesn't want the list (unlikely), mention in the document that
there might be minor deviations in code comment text.

> -----Original Message-----
> From: John Posada
> Sent: Wednesday, April 20, 2005 2:43 PM
> To: TECHWR-L
> Subject: Do you spellcheck Code Comments
>
> ...In the document, would you correct the spelling of "Exectute"
> or would you send a note to the developer. wait for him to
> fix it, and if he does, then make the change in the doc?

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Re: What do you want from help? (was: Do online helps have chapter numbers)
Next by Author: RE: Workflows
Previous by Thread: Re: Do you spellcheck Code Comments
Next by Thread: RE: Do you spellcheck Code Comments


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

Sponsored Ads


Sponsored Ads