Re: meeting-topic: documentation

I don't have any documentation uncommitted. Generally, the documentation 
is available through cvs (checkout "documentation" instead of 
"mod_survey").

For syntax reference, there's a perl script for dumping the available 
parameters and default values to stdout, see 
Survey/Component/buildSyntaxRef.pl. In the rare occasions when I update 
the documentation I compare the reference to this.

For code documentation, I started writing one ages ago, but decided that 
too few people would read it for it to be worth the huge effort of 
producing something readable.

   // Joel


On Fri, 23 Sep 2005, Michael Waider wrote:

> Hi,
>
> we were doing some tests with 3.2.3-pre1 lately and missed an
> uptodate syntax-reference a lot. So we decided to care about the
> documentation-issue at the developer-meeting.
>
> We will prepare a short presentation of documentation-approaches
> in software-development and which of them are most useful for our
> concerted efforts. After the meeting we will take care about
> documentation-updates to have at least the syntax-reference
> uptodate when 3.2.3 stable will be released.
>
> So please send in everything about documentation in advance
> (@Joel: the current documentation-sources, @Bugant/Martin:
> anything you have noted about your latest code-contributions,
> @all: any ideas or wishes about a practical documentation-system
> for modsurvey).
>
> thx + cheers    Mike
>
> -- 
> eveca GmbH - Internet & Befragungen - http://eveca.de
> Fon: 0941/785368-0 - Fax: 0941/785368-99
> Skickat av Michael Waider <[email protected]>
> till survey-discussion
>
Skickat av Joel Palmius <[email protected]>
till survey-discussion