I am seeing us fall into some bad habits with regard to user 
documentation. Glancing over some recent doc commits it seems we are 
falling back into "wiki-like" informal language and slang.

Remember that the accepted style guide reminds to avoid slang and 
"colorful" language. But also to be direct.

http://docs.geoserver.org/trunk/en/docguide/style.html

I of course realize that not everyone is a native english speaker. Which 
I think is another reason to have a maintainer for docs in each language.

I also think that it will be useful to again point that the sphinx docs 
are meant for "production" or "finished" docs. (Or at least that was my 
understanding). For stuff that is meant to be quickly mocked up I think 
the wiki is still appropriate. I know this results in work in porting 
docs from the wiki to sphinx when they are ready. But I think it is more 
important to preserve cleanliness in the docs, and avoid the state that 
the confluence user guide is in (a mess).

2c,

-Justin

Mike Pumphrey wrote:
> I don't think the idea was abandoned, but I also don't think it was adopted 
> as dogma.
> 
> Is there a section I should take a look at and/or go in with my vacuum 
> cleaner?  :)  Just let me know...
> 
> Thanks,
> Mike Pumphrey
> OpenGeo - http://opengeo.org
> 
> 
> Justin Deoliveira wrote:
>> Hi all,
>>
>> Apologies if I missed something while I was away but I thought before we 
>> more or less agreed that we would adopt Mike as the user guide doc 
>> maintainer and that non-trivial changes should go through him via patches?
>>
>> Did we abandon that as a bad idea?
>>
>> -Justin
>>
> 
> ------------------------------------------------------------------------------
> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
> trial. Simplify your report design, integration and deployment - and focus on 
> what you do best, core application coding. Discover what's new with 
> Crystal Reports now.  http://p.sf.net/sfu/bobj-july
> _______________________________________________
> Geoserver-devel mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/geoserver-devel


-- 
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with 
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Geoserver-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

Reply via email to