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.
We use an Agile development methodology, but our developers nevertheless
use Bugzilla to track all bug fixes and change requests. When we are
ready for a new release, I simply export a table of changes from
Bugzilla and do some minor editing. In other words, Bugzilla is the
collaborative tool, and it is updated throughout the development
lifecycle so there is never a mad scramble to put together a Readme.
Leonard C. Porrello
-----Original Message-----
From: techwr-l-bounces+ora=dita-exchange -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+ora=dita-exchange -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Robert Partridge
Sent: 17. april 2008 07:49
To: techwr-l List
Subject: Collaborative tool for Readme writing
Every time we release a product we have a mad scramble to collect
information together for readmes and release notes. Emails fly
everywhere, hand written notes, everyone has an input and coordinating
the mess takes far longer than it should.
I was wondering if anyone uses or knows of a collaborative system where
people can log in and make changes to a networked readme file online
using a basic editor (our files are distributed in basic .html format.
Nothing heavier than <p>, <h1-6>, <li>, and links etc.), such that the
networked copy can be grabbed at any time for the build and I don't have
to spend days sorting out the mess?
Anyone should be able to log in to the thing and make changes.
Changes should be tracked so we can look at earlier versions and see who
made the changes.
The file should have a static name and location so it can be retrieved
easily by our automated build process.
The editor should be easy to use and not load the file with excess
pseudo-HTML garbage.
Preferably there should be no clean-up stage to get the file into the
correct format/style.
Cheers,
Rob Partridge
Technical Writer
Citect
Tel +61 (0)2 9496 7514
Fax +61 (0)2 9496 7399
Mob +61 (0)403 609 007
robert -dot- partridge -at- citect -dot- com
______________________________________________________________________
This email has been scanned by the MessageLabs Email Security System.
For more information please visit http://www.messagelabs.com/email
______________________________________________________________________
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats
or
printed documentation. Features include support for Windows Vista & 2007
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 ora -at- dita-exchange -dot- com -dot-
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
Leonard -dot- Porrello -at- soleratec -dot- com -dot-
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-
