Another tip for people wanting to write documenation is in using Drupal with the book module - that's how I've been writing my own (sadly unfinished) docs. Drupal allows embedded code in it, so its easy enough to provide demos, as well as providing a book-like structure.
I intend to finish writing up docs for my plugin this weekend before attacking my new codebase this week, in which there will be some major API changes. On 14/08/07, Mike Alsup <[EMAIL PROTECTED]> wrote: > > Thanks everyone for the feedback and comments. I've received some > good suggestions for enhancements and I'm expecting to post another > update later in the week. > > To Joel's point, I made a template for my docs a while back. If > anyone is interested in getting a copy of it then I'll clean it up, > zip it up, and post it. > > Mike > > > > > One of the aspects of your plug-in offering to the community, > > > Mike, is the good documentation and, especially, demos for beginner, > > > intermediate, and advanced users. > > > > > > That approach to documentation, usage, and demos will help bring > > > many new people into the jQuery fold. > > > > > > Plug-in developers take note! :o) > > > > > > Rikc > > > > Yes, I think Mike's documentation and demonstrations are consistently > among > > the best out there. Simple to understand with very useful examples. > > > > I wish it was possible to create some sort of template so plugin > developers > > could fill it out and it would generate documentation as helpful as Mike's > > is. Or at least some basic shell with HTML and CSS files to kick-start the > > documentation process. As Mike says, the documentation is every bit as > > important as the code. jQuery makes it relatively easy to create the > plugin > > code, but we are on our own when it comes to creating the docs to explain > it > > to the public. > > > > Was that a rant? I hope not - I just wonder if anyone has any ideas. Sorry > > for going off-topic. > > > > Joel Birch. > -- Tane Piper http://digitalspaghetti.me.uk This email is: [ ] blogable [ x ] ask first [ ] private
