Re: Including Notification emails in documentation

Subject: Re: Including Notification emails in documentation
From: Goober <techcommgoober -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 8 Aug 2002 06:15:03 -0700 (PDT)


> I write docs for a web-based application that on
> occasion will send out notifications via email. I
> am having a discussion with the product developer
> who thinks it would be useful to include a catalog
> of the messages in the user guide. There are a lot
> of notification messages. BTW, these are purely
> informational and are not error messages. I really
> don't think they would add much value to the
> documentation, but I wanted to know others opinions
> before I address this with him again.

If they contain useful information, pull the useful
bits our and include the info in the appropriate
sections of the docs. Including a catalog of random
bits of info and advice wouldn't be all that useful
IMO, though the info therein might be very useful.
Talk with the developer and see if he/she is cool with
wrapping the useful info in with the pertinent info in
the documentation.

__________________________________________________
Do You Yahoo!?
HotJobs - Search Thousands of New Jobs
http://www.hotjobs.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Want to support TECHWR-L? Get shirts, bags, hats, clocks,
and more from the TECHWR-L Store. All proceeds support TECHWR-L.
http://www.cafepress.com/cp/store/store.aspx?storeid=techwhirl

Save up to 50% with RoboHelp Deluxe. Get 2 great products for 1 low price!
You'll get RoboHelp Office PLUS RoboDemo, the software demonstration tool
that everyone's been talking about. Check it out and save!
http://www.ehelp.com/techwr-l

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



References:
Including Notification emails in documentation: From: Wade Courtney

Previous by Author: Re: Pleasing a Manager
Next by Author: Re: Work... It's Gooberrific!!!
Previous by Thread: Including Notification emails in documentation
Next by Thread: RE: Including Notification emails in documentation


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

Sponsored Ads


Sponsored Ads