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.
hehe good question about what customers want. I don't think they even read
it..they are a lazy bunch.
On 8/22/07, Combs, Richard <richard -dot- combs -at- polycom -dot- com> wrote:
> Zen C wrote:
> > The person reviewing my release notes came up with this suggestion.
> > Add screen shots for items that have one. For example if
> > printing options are changed for something, explain the way
> > it is done and add screen shots as it would be in the help
> > file. I know you point them to the Help system, which is
> > great, but they are lazy.
> > Any suggestions on this comment ? Do release notes usually go
> > out with a lot of details or is a brief outline of what is
> > changed only?
> All together, now: "It depends!" :-)
> We include screen shots when they serve to quickly explain something
> that would otherwise require lots of words. A new printing option
> wouldn't qualify; it would just be mentioned in a bullet list or table.
> A new dialing restriction feature does qualify, because a good picture
> of the interface pretty well explains the feature.
> But we provide a fair amount of detail because a couple of big customers
> wanted it. What do your customers want?
> For new releases of existing products, almost everyone expects to see a
> table of resolved issues (bug fixes) and a table of unresolved issues,
> along with their workarounds.
> Richard G. Combs
> Senior Technical Writer
> Polycom, Inc.
> richardDOTcombs AT polycomDOTcom
> rgcombs AT gmailDOTcom
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-