RE: Collaborative tool for Readme writing

[<richard -dot- melanson -at- us -dot- tel -dot- com>]

 WIKI or a Blog would work. 
Rick


-----Original Message-----
From: techwr-l-bounces+richard -dot- melanson=us -dot- tel -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+richard -dot- melanson=us -dot- tel -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Sandy Harris
Sent: Thursday, April 17, 2008 8:04 AM
To: TECHWR-L
Subject: Re: Collaborative tool for Readme writing

Robert Partridge <Robert -dot- Partridge -at- citect -dot- com> wrote:

> Every time we release a product we have a mad scramble to collect  
> information together for readmes and release notes. ...
>
>  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.

Wouldn't a Wiki page give you all of that? It is simple HTML with some Wiki markup. Any Wiki software gives you a simple editing interface, with records of the edit history and ability to retrieve old version.

>  Preferably there should be no clean-up stage to get the file into the  
> correct format/style.

Wiki to pure HTML is prety straightforward.

--
Sandy Harris,
Nanjing, China
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 richard -dot- melanson -at- us -dot- tel -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/richard.melanson%40us.tel.com


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
http://www.techwr-l.com/ for more resources and info.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.