Collaborative tool for Readme writing

Subject: Collaborative tool for Readme writing
From: "Robert Partridge" <Robert -dot- Partridge -at- citect -dot- com>
To: "techwr-l List" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 17 Apr 2008 15:49:29 +1000

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.


Rob Partridge
Technical Writer

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

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.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: Replacing "master" and "slave" terminology
Next by Author: RE: Collaborative tool for Readme writing
Previous by Thread: Re: Estimating a project rate?
Next by Thread: RE: Collaborative tool for Readme writing

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

Sponsored Ads