Getting more user documentation help (was Re: [xwiki-users] Authoring templates and design sheets not working for custom class)

[Vincent Massol]

Hi Roopesh,

On Aug 10, 2007, at 4:31 PM, Roopesh P Raj wrote:

[snip]

>> Documentation is done by the community, i.e. people like you. I  
>> agree it's a little bit disappointing that lots of users do not  
>> participate more to documentation since they get a software for  
>> free, ask a lot of questions and when they get their answers they  
>> don't even bother to reinject their knowledge into the  
>> documentation for the benefit of others. I hope you're not like  
>> these users! :)
> I have some small suggestions :
> One is can we have some logical structure in place, say, empty  
> links, which others can edit and add content to it. For example,  
> one of those can be, Search tips: people can add different  
> scenarios and the queries that apply in that scenario.

I'm ok with this for some special pages. But not for all pages. It's  
a double-edged sword. I think it's important that xwiki.org offers a  
professional view of XWiki. If we have empty links everywhere, it  
doesn't look "finished" (and btw people mistakenly follow the link  
and save the empty page thereafter leading to confusion for other  
users who don't understand why there's an empty page!)

Search tips is a good idea? Where would you see this page located on  
xwiki.org?

> Another is to classify the FAQ into proper sections. There are a  
> whole lot of information in the mailing list which can make way to  
> FAQs so that a new comer will be at ease. If structured properly,  
> FAQ will be of much use, I guess.

yes, that would be nice. Any idea of how to do this?

> Another is a tutorial more elaborate than the current FAQ tutorial.  
> A mini application which will give a new comer a feel of what can  
> be done using xwiki.

Like this: http://jira.xwiki.org/jira/browse/XWIKI-732 ? :)

So who's doing it? :)

Thanks
-Vincent