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.
Subject:Question about release notes From:"Julie F. Hesselgesser" <jhesselgesser -at- OXMOL -dot- COM> Date:Tue, 8 Jul 1997 13:05:27 -0400
Are there any standards or rules about what constitutes release notes? My
boss wants to create a hard copy Word document that outlines the new
features of our next release. He is planning to include screen shots and
procedural instructions. He's calling this document "release notes." I've
always seens release notes produced as ASCII text files. I've never seen
screen shots in release notes. He feels the changes are substantial enough
to warrant this level of documentation. (Obviously, I'm not in agreement.)
We just finished producing a nice set of hardcopy manuals for the current
version. Has anyone ever had to document new screens right after producing a
manual? How have you handled this? I always thought users were sort of on
their own with interim releases like this. I was planning to document the
new screens and features in the documentation for the next major release.
Julie Hesselgesser
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
