Re(2): Release notes: term for bugs

Subject: Re(2): Release notes: term for bugs
From: Jan Henning <henning -at- r-l -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 12 Jun 2002 21:08:34 +0200


>On the topic of release notes, what's the standard format? ASCII, RTF or
>HTM?

I don't think there is a standard format. But here are some suggestions:

- It is paramount that every recepient be able to read the release notes.
This rules out RTF - unbelievable as it may seem, there are actually
users who do not have Word. (Of course, if the release notes are for a
Word add-on, it would be different.)

- Text (Ascii) is the most easily read format, but limits you in what you
can do. Long release notes (more than one or two pages) quickly become
confusing in Ascii.

- HTML can also be read by almost everybody. It lets you include graphics
but allows only limited control over the layout (unless you really put
effort into it).

- PDF can also be read by almost everybody. Some users may not yet have
the reader installed, requiring a spearate step before they can access
the text. PDF gives you the most control over the layout, allows easy
printing, good navigation, and is foolproof because it encapsulates
everything.

- If the relase notes are for a graphics or layout application, or if
they are for an add-on to such an application, you could do the release
notes in that application. There may be font issues, however.

Our current favorite is PDF. Before you decide on a format, you may wnat
to analyze what your users want and what tools are available to them.

Hope this helps
Jan Henning

--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany

Phone: +49 700 0200 0700, Fax: +49 8179 9307-12
E-Mail: henning -at- r-l -dot- de, Web: www.r-l.de
--------------------------------------------------------------------



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


References:
RE: Release notes: term for bugs: From: Femila Anilkumar

Previous by Author: Re(2): Release notes: term for bugs
Next by Author: Re(2): Anyone familiar with "aspforums"?
Previous by Thread: RE: Release notes: term for bugs
Next by Thread: Re: Release notes: term for bugs


What this post helpful? Share it with friends and colleagues:


Sponsored Ads