Hi Silvia, On Mar 1, 2010, at 10:58 AM, Silvia Rusu wrote:
> > Hello, > > I would like to propose we update the User Guide documentation so that it's > more helpful to users that start using XWiki, whether they are programmers > or not. The purpose of the guide is to get users up to speed with the XWiki > basics, to gather these resources in one place. > > You can find my proposal for the user guide here: > http://dev.xwiki.org/xwiki/bin/view/Drafts/UserGuide > > Please feel free to make suggestions for other pages to be included or > changes you think should be made. Remember this is not a TOC for all the > documentation, but rather a selection of links to help you get started with > XWiki. Good start! It's cool that you're working on this, we absolutely need it :) Some feedback: * It doesn't feel like a guide right now. It seems to be a collection of links to other places. Personally I like that because it avoids duplication. However I wonder what will first time users think. It probably makes it hard for them to read. Also the current getting started guide from Guillaume (which would disappear as a consequence) has a lot more texts and explanations that need to be reintegrated in the user guide. * It's missing an overall TOC * I only see "XWiki Basics" but this guide is supposed to be a full guide to all features. Is it simply because it's not finished? How would you organize the rest? * I think you need the guide to start with a single page that is a TOC and have more separate pages. This will come naturally as a consequence of adding more explanations/texts to the each section (see first point above). * The guide needs a lot more screenshots IMO. There should be screenshots everywhere. Remember that an image is worth a thousand words ;) Thanks -Vincent > Thanks, > Silvia _______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
