Hi Stephen,
Sure we want much better documentation than there is now. These are all
good ideas..
One of the things we need to solve first is how the documentation will
be managed.
Currently there is:
- a FAQ on
XWiki.com which has mainly general stuff and some stuff
related only to
XWiki.com
- a Tutorial to XWiki on
XWiki.com
- a default wiki for
XWiki.com (in French and English)
- a default wiki for offline installs (in English only)
The offline install default wiki differs very slightly from the
XWiki.com default wiki. One could be derived from the other.
I'm not sure the XWiki documentation should be copied over to the
offline wiki install. I'm more a fan of a link to the online
documentation. Maybe we could trick the wiki to display this
documentation inside the local wiki look and feel (if the skin was
changed) using InterWiki includes (which would be needed to be developed
but would make a lot of sense).
Now I think we should move the documentation to the
xwiki.org web site
in a specific area. Using some XWiki classes, we can mark the
documentation articles that are specific to
XWiki.com.
We can definitively open the default wiki to developer's editing so that
people can contribute to it's improvement. We can then have an automated
export to XML so that we can release it on ObjectWeb regularly.
Documentation is a weak part of XWiki. We are definitively looking for
people that can help in this area.
Ludovic
Stephen Schaub a écrit :
Are there any plans to develop improved documentation
for the 1.0 release?
In the initial wiki installation, it would be nice if there were a
nice "Getting Started" guide for users that explains how to do basic
wiki administration, etc.
One way to develop this might be to create a virtual wiki at something
like
home.xwiki.org where current Xwiki users could contribute to
developing the initial home page that appears in a default
installation. Thoughts?
Stephen
--
Ludovic Dubost
XPertNet:
http://www.xpertnet.fr/
Blog:
http://www.ludovic.org/blog/
XWiki:
http://www.xwiki.com
Skype: ldubost AIM: nvludo Yahoo: ludovic