We, actually, just started work on a jQuery FAQ that follows this format exactly: http://docs.jquery.com/Frequently_Asked_Questions
Some include live demos, most have code. It's not perfect, but I have a text file with a list of things that should probably be tackled in it. Sitting in the IRC channel all day is a great way to pick up on these questions. --John On 8/2/07, Mitchell Waite <[EMAIL PROTECTED]> wrote: > > The documentation is excellent and one major reason I am here. > > As a publisher and writer of computer books, I think I know exactly what the > best next step would be for improving the docs. > > Before I sold Waite Group Press to Simon and Schuster we had two very > successful lines of language books > > Bibles (ergo reference guides) > How To's (e.g. How Do I..Call a Javascript Function from jQuery) > > We let IDG (now Wiley) and others do the dummies books because that area of > the market was a gold mine if you hit it first. I am hoping we will see a > Head First jQuery from O'Rielly and a jQuery Visual QuickStart from > Peachpit. > > We know Karl has a reference book coming out from Packit (you should all > preorder it to support our local authors) > > WHAT IS NEEDED FOR A JQUERY LEARNING RESOURCE > > I think jQuery could benefit greatly from a simple How To > document/book/website addition/etc. If we followed my model the pages would > be a collection of How Do I...(do something in jQ) in a standard format. It > would need a super table of contents and be set up for searching concepts. > > The key is picking a range of really really good How To's. If any of you > have our old Visual Basic How To that sucker really sold well because we > worked very hard picking good examples. > > I've been thinking about what these might be and have a lot of other ideas. > In our books we would start with the most basic uses of jQuery and move up > in difficulty and level towards later chapters. We would aim to have How > Tos that actually did things that are useful but we would try and keep them > short as possible. > > I have started a How To list because as a novice I am very aware of the > simple assumptions the docs make and the very important things you need to > know early about syntax and basic concepts. > > If anyone is interested in working with me on such a project, let me know > offline and I will report back here if I spark any interest. > > Mitch > > -----Original Message----- > From: jquery-en@googlegroups.com [mailto:[EMAIL PROTECTED] On > Behalf Of Terry B > Sent: Thursday, August 02, 2007 7:18 AM > To: jQuery (English) > Subject: [jQuery] Re: Do you think jQuery's documentation is enought? > > > I like http://www.visualjquery.com for my jquery documentation... > > yes there is lots of room for "improvements" but it's a working and > living project which is constantly changing and I think the project > managers are doing a great job to date... and demos? look at the > plugin pages for demos... imho the core documentation should only be > techinical with little to no examples... like the link above, they > give a two liner example with before and after expectations.... that > is more then a programmer deserves and is just icing on the cake... > > asking for demos of the core is like asking the creators for included > libraries in any language (like c, c++, etc) to provide demos of the > library functions when the coder only needs to know the name, input > parameters and the expected output... > > ~Terry > >
