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:RE: Release notes and readme files From:"egalite" <egalite -at- westnet -dot- com -dot- au> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 22 Oct 2006 18:09:14 +0800
Excellent points, thank you!
(and nice tie-in with development processes, something I find is a problem
in many companies, big or small)
Trish :)
Steven Jong wrote:
: When writing release notes/readme files, one important
: distinction to
: make is between bugs found by customers and bugs found during
: testing. The former should wind up in the release notes in one of
: three places: if it was fixed, as a bug that's been fixed; if it
: hasn't been fixed yet, as a known issue; if it's not going to get
: fixed, as a clarification.
[snip]
: If after discarding "virtual" bugs you still have a
: substantial list,
: you have a problem with your development process, not your release
: notes.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-