Have you explored any automated ways of generating documentation based off the code? Like a javadoc type system?
Maybe having an API reference as well as quick reference guides would be helpful. I find that having different "levels" of documentation helps adaptation of the software to beginners and advanced users alike. Thoughts? Matthew On Mon, Jan 19, 2009 at 8:30 AM, Martin MC Brown <[email protected]> wrote: > Hi, > >> I think there should be a syntax guide or quick-reference. >> What are the syntax differences between Drizzle and MySQL? >> If there are only some differences, we should document the delta >> between the two. > > I'm looking into doing something like this, as automatically as possible. > >>> One thing that I found lacking in the MySQL documentation were links to >>> the >>> syntax elements. For example when you look at the syntax of the select >>> statement and see that the "Where" key word is followed by a >>> "where_condition" it would be nice if you could click on the >>> "where_condition" and it would bring you to the point in the >>> documentation >>> where it is described. > > We are working on this functionality, but it isn't a straightforward thing > to do when you take into account the four different versions of the manual > (or, in some cases, the differences between storage engines). > > MC > > -- > Martin MC Brown, Technical Writer > Database Technology Group, Sun Microsystems > http://sun.com | http://mysql.com > Phone: x18435/+44 247 669 8435 Skype: mcmcslp > > > > > _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
