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: what's your standard like? From:Bruce Byfield <bbyfield -at- axion -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 11 Oct 2005 13:53:42 -0700
On Tue, 2005-11-10 at 13:13 -0700, Jenn Wilson wrote:
> The primary goal for these is business development.
You don't mention whether these release notes are also going to
programmers or not. If they are, may I suggest that you create separate
documents for these two audiences?
A single document, of course, is easier to maintain. However, neither
audience is likely to be satisfied with what the other wants. The
technical information wanted by programmers is unlikely to be well
received by business development. The same is true in reverse for any
marketing information.
Even the format is likely to cause problems. Business development may
want nicely formatted text, while programmers are likely to object to
having to open a word processor to read release notes.
"You bought all the props for a world that never was,
Now there's holes in the mirror, and less and less applause,
We are all ungrateful bastards, like a dog that bit your hand,
All these years and you still don't understand."
- OysterBand, "Too Late Now"
Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l
Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
