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 Note problem From:Sue Clark <Sue_Clark -at- Allegis -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 15 Dec 2000 15:17:22 -0800
I'm not quite sure, based on your message, but are you supposed to write a
note for each build? Or only for the "release" build?
Where I'm at we had the engineers write release notes for a major build
based on what they've added or changed. I took that information and compiled
it into a more coherent structure for the release notes. Each engineer also
has to review the release note to make sure its complete and correct. And,
the final version also needs to be reviewed by the engineering lead and the
program manager.
You should tie the notes to a software version, if possible. If a specific
version is not available or used, relate the notes to the build date.
As much help as you can get from the engineers (I know, I hear some of you
snickering) the better. They know what they've done and should be able to
provide you with information about changes or, at the least, tell you what
has changed.
regards,
--Sue
-----Original Message-----
From: Jackie Gishkin [mailto:jgishkin -at- temposoft -dot- com]
Sent: Thursday, December 14, 2000 5:08 AM
Subject: Release Note problem
Hello,
I have just started a job as a technical writer in France without having
any real prior experience. My first project is to write Release Notes
for the latest build for our "internal software". The problem is that
the Builds are changing everyday. Recently, I have started to write
about a new feature only to find out that it had completely changed 2
days later. I now have to go back and delete what I wrote. I was told
that I will be printing out the Release Notes once we come across a
really "good" Build.
Also, instead of having a few Release Notes floating around for the same
Version, is there a way to compile them together into one coherent
document?
Since I am in a start-up, there haven't been any established ways for
doing technical documentation.
Do any of you have some advice to give me? I would apprciate it.
Thanks in advance,
Jackie Gishkin
Temposoft, FRANCE
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.
