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.
I'm the tech writer for a small software company (Executech - look us up at
www.executech.com). Our release notes are fairly thorough and do include
screen captures and actual step-by-step instructions. My rule of thumb is
if I write it correctly for the release notes, I can pop that section out
and plug it into the actual manual with minimal rewriting (however, I often
elaborate upon it in the manual). I document new features (which are
constant) first in the release notes. Once that section has been reviewed
and approved, I add it to the appropriate chapter - therefore, I always
know the most up-to-date documented information is in the release notes.
- Eric
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
