TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
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.