Re: [xwiki-users] Documentation Guide

am I only a person, who thinks xwiki needs something like that? http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocContribution

Regards, Roman Am Sonntag, den 27.09.2009, 12:26 +0200 schrieb Roman Friesen: > Please look at > http://dev.xwiki.org/xwiki/bin/view/Drafts/XEMainProposal > > Sometimes I linked to existing pages, sometimes to new drafts/ > proposal > pages. These are: > - How to contribute proposal: > http://dev.xwiki.org/xwiki/bin/view/Drafts/XEContribute > - Documentation proposal: > http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain > - Documentation Guide proposal: > http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocContribution > - User cookbook proposal: > http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocUserCookbook > > Especially the Documentation Guide is very important, as it defines > the > way, how the documentation should be worked on. > > Any feedback would be very appreciated. > > P.S. > 1) My comments are marked as quotes and/or just with italic style. > 2) I would thank www.ubuntuusers.de, where I could collect really > good > documentation experience. > > Thanks, > Roman > > > Am Freitag, den 25.09.2009, 18:19 +0200 schrieb > roman.friesen(a)ropardo.de: >> Hello, >> >> in my opinion, the current xwiki documentation is not optimal in >> many >> ways: >> - not well structured >> - not up-to-date >> - unclear where/who/how should take care about that (it's for >> everyone >> editable now, but it doesn't seem to be a really good approach...) >> >> I would suggest to separate the final documentation and writing of >> the >> documentation, for example with two spaces: >> 1) final docs >> - no comments >> - editable only for the doc team >> 2) staging (writing, reviewing etc.) >> - with comments >> - editable for all registered users >> Among other things (quality), in this way all users can contribute >> to >> the documentation without having fear to make mistakes. >> >> If you like, please create a staging space for the Xwiki Enterprise >> documentation, then I could start with a basic structure, process >> description etc. >> >> Best regards, >> Roman