I disagree about the FAQ as the better documentation for OS projects. Yes they are necessary, but user guides have to be the first step to get to know a new system. With user guide I mean a step by step guide that teaches to the newbie
1) how to setup environment and start developing simple things (hello world and little more) 2) how to integrate common third party libraries (ORM, logging) or products (Javascript libraries) 3) how to realize various type of applications with the framework (web applications, web service, CRUD operations) I think that 80% of development tasks are common to all web projects FAQs are useful for common problems, not for common tasks. Just my 2 cents Il 18/08/2010 2.33, Howard ha scritto: > I'm taking some time to work on the Tapestry documentation ... starting > with the FAQ. It's great fun, though this could get to be quite large. > I'm just spewing out content right now, over time we'll clean it up, > reorganize it, and add further hyperlinks and annotations. > In fact, as I'm working on the FAQ, I'm thinking this might be the best > way to document open source projects in general. User's guides and > reference documents are rarely read, everyone just Google's their > question, so put those questions in their most findable format. Also, > it's hard to write a consistent user guide start to finish ... but more > reasonable to document one tidbit at a time. > Also, I'm reminded of The Little Schemer, a book that teaches the > entire Scheme language (a Lisp variant) via a series of questions of > ever broadening scope. > Feel free to suggest additional FAQ topics on the Tapestry Users > mailing list. > > -- > Posted By Howard to Tapestry Central at 8/17/2010 05:33:00 PM > -- ================================================== dott. Ivano Mario Luberti Archimede Informatica societa' cooperativa a r. l. Sede Operativa Via Gereschi 36 - 56126- Pisa tel.: +39-050- 580959 tel/fax: +39-050-9711344 web: www.archicoop.it ================================================== --------------------------------------------------------------------- To unsubscribe, e-mail: users-unsubscr...@tapestry.apache.org For additional commands, e-mail: users-h...@tapestry.apache.org
