cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Diana Shannon <>
Subject Re: Document Gestation Process?
Date Mon, 29 Apr 2002 15:53:13 GMT

On April 29, 2002, Bertrand Delacretaz wrote:

> A specific cocoon-docs list for documentation developers would help a 
> lot
> IMHO. Cocoon-dev is busy enough, and I like the idea of motivating 
> users that
> might not be programmers to contribute to the docs.

I agree. I understand, however, that such an effort may die if migration 
is premature. Still, I think there's probably a great number of 
potential participants on the users list who don't yet know about this 

> By the way, does your documentation process account for translations in 
> other
> languages? Making them part of the scheme could be useful in the near 
> future,
> depending on how many "doc-committers" show up ;-)

Yes, good point. I am working on writing guidelines to help writers make 
future translations easier. This includes anticipating machine-language 
translations as well. Do you have other ideas?

>> . . .
>> - How do we match SMEs to documentation efforts, particularly for
>> advanced topics?
>> . . .
> I'd use the "docs" list for this as well, and let the experts speak up
> without designating them from the start. Maybe a set of subject line 
> tags
> ([DOC-REVIEW], [TOPIC-QUERY], etc.) would help. These "open reviews" 
> work
> well for code now, I don't think a more formal process is needed.

Yes, I agree with you, 100%. I think this is a *much* better model. But 
right now, we don't have this :(  and it was my understanding (from the 
limited number of responses I receive to earlier posts) that some feel 
it's too early to move this off cocoon-dev.

> On another subject, I think publishing documents with numbered 
> paragraphs
> (and numbering documents themselves?) would help during the reviewing 
> stage,
> allowing terse but precise quotations.

Good point.


To unsubscribe, e-mail:
For additional commands, email:

View raw message