http://youtube.com/watch?v=Pk7yqlTMvp8 Priceless!
I have offered to build or help build a CMS for jQuery that would > > do what I've described above…. > I believe the wiki can be used to add documentation for plugins that are not official, but I may be mistaken. It just becomes frustrating when trying to track down information, etc. > But the list is always ready to provide guidance, and it's much > appreciated. > And I agree with you and this goes back to what I was kinda saying in my other email. If you come across a lack of something and you search and ask and eventually come up with the answer, taking that info that you found and passing it on to the developer in a "general user" directions/docs type of way, that helps out tremendously. Because now the developer gets the docs he/she did not realize he/she was missing and can implement it for future users. For instance, my jqGalScroll plugin was lacking a large amount of user friendly docs, I documented it a lot for what I thought everyone needed, but still was lacking, and still is, but I had a user of that plugin email me directly explaining his problem and how he fixed it and with some communication back and forth, I was able to figure out a better way of describing what I needed to do. Anyway, I am rambling, but you bring up great points and I would just ask that you and other users pass on any information that is helpful to a particular plugin. On 10/28/07, Yehuda Katz <[EMAIL PROTECTED]> wrote: > > I'm going to start taking a more active role as the official cat herder > (plugin lead). A number of people had ideas at jQueryCamp that were very > intersting to me and will drive innovation in this area. Stay tuned! > > Sent from my iPhone > > On Oct 28, 2007, at 3:15 PM, "Rick Faircloth" <[EMAIL PROTECTED]> > wrote: > > Hi, Ben… > > > > I'm sure there is a lot of work going on to help "herd all the cats" > > that I don't know about. > > > > I guess that is one of the greatest strengths and greatest weaknesses > > of jQuery: its growing and thriving community of "development > entrepreneurs"… > > > > It's a great strength because there are so many actively developing for > > the platform…but, therein lies, perhaps, it greatest weakness. With the > vast array > > of developers "running amok" (in a good way) creating new plug-ins and > > developing new techniques, it's just hard to keep up with it all. > > > > And your reference to the documentation available is a good example > > of the problem. For instance, there's the official documentation at > > <http://docs.jquery.com/Main_Page>http://docs.jquery.com/Main_Page, and > Visual jQuery at > > <http://www.visualjquery.com>http://www.visualjquery.com, and jQuery API > Browser at > > <http://jquery.bassistance.de/api-browser> > http://jquery.bassistance.de/api-browser and also Learning jQuery at > > <http://www.learningjquery.com>http://www.learningjquery.com, et al. Docs > are scattered out everywhere, > > not to mention the documentation on individual plug-in sites, "how-to's" > > on blogs, etc. > > > > Prosperity always includes a degree of chaos…if we only had the core and > > one plug-in we wouldn't have much of a problem, would we? :o) In other > words, > > we have a "good problem." > > > > Anyway, I'm just hoping for a content management system that core > developers, > > plug-in developers, and users can all access as a repository and > reference. > > > > And believe me, when I say I wish I could offer more technical help with > jQuery. > > Unfortunately, I'm still too wet behind the ears. > > > > However, I have offered to build or help build a CMS for jQuery that would > > do what I've described above…. but perhaps something very similar is in > the > > works behind the scenes. But, then, I wouldn't be able "jQuery it" > enough, > > I'm sure, because of inexperience. > > > > And, concerning my remark about volunteers… I don't want to reference > > being told that (it should be in the list archives), because I don't want > to start up any > > trouble… all the volunteers are GREATLY appreciated for what they do now > > and I don't want anyone to think otherwise. But my reference to being > told > > that developers are volunteers, etc., is true, and I understand it. > People give > > out of their generosity, not because they're paid. And everyone only has > so much > > free time to give. > > > > I'm just gently complaining about the situation. We have this great list > as > > the most important resource of all, I think, because of so many willingly > give > > of their time and expertise to help newcomers like me along. > > > > It just becomes frustrating when trying to track down information, etc. > > But the list is always ready to provide guidance, and it's much > appreciated. > > > > Rick > > > > *From:* jquery-en@googlegroups.com [mailto:[EMAIL PROTECTED] *On > Behalf Of *Benjamin Sterling > *Sent:* Sunday, October 28, 2007 12:49 PM > *To:* <jquery-en@googlegroups.com>jquery-en@googlegroups.com > *Subject:* [jQuery] Re: Consider a standard documentations for plugins > > > > I am going to have to disagree with your feelings Rick. There is a ton of > work going on to help out with documentation. I believe it is David Serduke > that is adding functional examples to each function in the jQuery > documentation. Feel free to go to > <http://groups.google.com/group/jquery-docs> > http://groups.google.com/group/jquery-docs and offer any help you can on > that front. > > "The response I always get is: Core developers and plug-in authors > are volunteers, so no one should expect that they will participate > in the work involved to coordinate and standardize the jQuery core, > plug-ins, and documentation." > > I don't think I read anywhere that said "no one should expect" part, > people say they do what they can. As I said before, I personally am not a > good writer, nor am I really good at explaining what I mean, but I am very > willing to except help from anyone that is willing. > > And as I mentioned in our last conversation[1], good documentation can > only happen with help from others. For instance, if you feel documentation > for any particular plugin is lacking, feel free to either contact that > developer directly with some constructive tips on how to improve their docs > or write up a set of docs that you feel will better the current docs for > that plugin. I truly believe that that plugin developer will not be > offended. > > Karl offered a great lecture this weekend on bettering your documentation > and I believe he will be posting it to his blog[2] and Mike Alsup [3], who > probably has the better documentation then any plugin author, posted a > template[4] for what he does and which I am trying to implement on my > plugins[5]. > > Ultimately this is just my two cents, but this is a community that we are > trying to build and helping each other out is the best way to strengthen > it. We are only as strong as our weakest link. > > [1] > <http://groups.google.com/group/jquery-en/browse_thread/thread/4c18b36d4e14dc9a/cd208523d73f7b94?lnk=gst&q=Rick+Faircloth#cd208523d73f7b94> > http://groups.google.com/group/jquery-en/browse_thread/thread/4c18b36d4e14dc9a/cd208523d73f7b94?lnk=gst&q=Rick+Faircloth#cd208523d73f7b94 > > [2] <http://www.learningjquery.com/>http://www.learningjquery.com/ > > [3] <http://malsup.com/jquery>http://malsup.com/jquery > > [4] <http://malsup.com/jquery/template.zip> > http://malsup.com/jquery/template.zip > > [5] > <http://benjaminsterling.com/2007/09/30/jquery-jqgalview-photo-gallery/> > http://benjaminsterling.com/2007/09/30/jquery-jqgalview-photo-gallery/ > > On 10/28/07, *Rick Faircloth* < <[EMAIL PROTECTED]> > [EMAIL PROTECTED]> wrote: > > > A good idea, Howa, however I've been barking up the > "standardization", "consistency", "documentation", > "plug-in-compatibility-with-various-jquery-versions", > "bring-all-this-together-in-a-standardized-format-in-one-location" > for months, now. > > The response I always get is: Core developers and plug-in authors > are volunteers, so no one should expect that they will participate > in the work involved to coordinate and standardize the jQuery core, > plug-ins, and documentation. > > Right now, it's just track down info as best you can find it, test > it all yourself to have any certainty, and good luck to you. > > As jQuery and its plug-ins mature, it's getting more and more difficult > to put the framework to use. > > Although jQuery has brought much to the JS world, we're getting what > we're paying for as far as standardization and documentation goes... > > There's time to write books, but no time to develop a database-driven > content management system to bring all the information on the core, > plug-ins, and documentation under one roof, or rather, one site. > > *sigh* > > Rick > > > > > -----Original Message----- > > From: <jquery-en@googlegroups.com>jquery-en@googlegroups.com > > [mailto:<jquery-en@googlegroups.com> > [EMAIL PROTECTED] On Behalf Of howa > > Sent: Sunday, October 28, 2007 5:57 AM > > To: jQuery (English) > > Subject: [jQuery] Consider a standard documentations for plugins > > > > > > Now, JQuery has many plugins, this is good. > > > > The bad side is different authors has different taste in writing > > documentation, I think it would be good to have a standard way to > > write documents, similar the one in the jquery doc., with examples, > > arguments description etc. > > > > It does not mean most authors are bad in writing documents, but using > > a standard way can help users to explore the plugin easier & faster. > > > > Also, it would be good if allow user to comment on the plugin just > > like what we have in php.net . People can contribute to build up the > > knowledge base, such as the plugin was broken with browser abc, > > workaround etc. > > > > > > -- > Benjamin Sterling > <http://www.KenzoMedia.com>http://www.KenzoMedia.com > <http://www.KenzoHosting.com>http://www.KenzoHosting.com > <http://www.benjaminsterling.com>http://www.benjaminsterling.com > > -- Benjamin Sterling http://www.KenzoMedia.com http://www.KenzoHosting.com http://www.benjaminsterling.com
