agree. how'd you like to write a wicket user's guide? ;-)
seriously, it would be great if someone updated my user's guide and finished it, let
alone wrote one from scratch. i don't imagine having the time to do that and there
doesn't seem to be anyone else ready to do that in the next couple weeks. so, the
question is, what is the next best substitute for a user's guide? my suggestion is
not ideal. it's just likely to be what we can accomplish with limited resources.
Gili wrote:
Personally, I found the user manual to be far more useful than independant FAQ entries. Especially for beginners, there need to be a feeling of cohesiveness.
Gili
On Sat, 19 Feb 2005 11:11:17 -0800, Jonathan Locke wrote:
given how busy everyone is, i'm starting to wonder if a user's guide isn't a little too ambitious right now. especially for 1.0. i just can't imagine it happening because there's too much to do and too few people who can work on it.
what i'm thinking might be good and useful to have for the 1.0 release instead would be more like a bunch of FAQ entries, much better documentation in the examples (i'd like us to get really fussy about these since most people look at the examples before they read the docs!) and a couple tutorials. and i'd suggest that we just remove the existing user's guide stuff for 1.0 (from the core doc folder) so people don't get confused by it (it's /really/ out of date now). i think we could do smaller stuff like this for 1.0 in a couple of weeks and do it well if everyone pitched in as much as they could... i've gone and updated the three "Quick Tour" pages on the web site so they are more like little micro-tutorials. this seems like a good start to the kind of "spot documentation" we have time for right now. if non-native english speakers would like me to proof their FAQ entries or tutorials, i'd be happy to pitch in there.
for myself, i'll have bugs to fix and a ton of other stuff to do in the next couple weeks, so i'd like to mainly contribute to documentation by working on javadoc and writing a couple of FAQ entries which answer questions that other people might not know the answers to. if people have questions they want answered in the FAQ or things they don't understand, one good way to do that is to file a doc bug and suggest the subject there.
btw, on the FAQ page on the website, i was hoping there was some xdoc way of doing FAQs so there's a bunch of "top links" in groups (by category) at the top of the page that link to the actual Question and Answer down the page. is that possible?
jon
Martijn Dashorst wrote:
Jonathan Locke wrote:
btw, was wondering which documentation project is the official one that we're working on. my assumption is that the wiki is where we're building the wicket user's guide. is that right?What is comforting the most. I was busy working on the wicket-userdocs project in docbook format. The wiki is less technical for others to contribute in, so I created that spot for easier collaboration. I think working in the wiki is the best place. I can easily put the text created there into the docbook format and release that when finished as a PDF, 1 page HTML and multipage HTML.
Martijn
jon
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Wicket-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/wicket-develop
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Wicket-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/wicket-develop
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Wicket-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/wicket-develop
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Wicket-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/wicket-develop
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Wicket-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/wicket-develop
