Hi people! I agree with Francois.
One point: write a demo application, in general, DOES NOT cover all the mapping properties, HQL, etc... I prefer the way PHP documentation is organized: every function, has one or more mini example. There is NO demo app for PHP: too much points to be covered by such kind of application. Examples: http://www.php.net/manual/en/language.oop5.properties.php http://www.php.net/manual/en/function.mail.php Note the help of programmers comment in that pages. The most relevant are incorporated to documenation. I prefer the effort is directed to: - "Doc coverage" of every (or main) feature - "Example coverage" of every (or main) feature As an example: I didn't read the current NH doc, but years ago, I was trouble understanding "inverse=" behavior and necessity, without a clear and dedicated example. (hmmm.. maybe, the trouble was with Hibernate doc). I guess a group of dedicated devs/users (I could help) could attack this "doc/example" coverage. Angel "Java" Lopez http://www.ajlopez.com http://twitter.com/ajlopez On Mon, Oct 25, 2010 at 10:42 AM, Francois Ward <[email protected]>wrote: > What I would add personally, in order of importance: > > -Make sure all of the mapping properties are documented. Some just have 1 > liners which makes it hard to know their purpose, never mind how to use > them. > > -Reference for HQL. Right now its mostly the Hibernate HQL doc nearly copy > pasted. I keep finding stuff you can do in HQL i didn't know about by > googling around :) > > -XML comments/docs on all the methods for intellisense. > > -Reference for what constructs of criteria/linq/hql generates in various > scenarios for the more common dialects, a little like what Ayende does on > his blog. I realize that one would take way too much work to write up, but i > can dream :) > > -Francois > > On Mon, Oct 25, 2010 at 8:35 AM, Fabio Maulo <[email protected]> wrote: > >> Consider this thread as a poll to know what you would like to have in our >> reference documentation. >> We know that we have some obsolete info, some incomplete info and a lot of >> info spanned in various blog posts. >> >> What you would like to have in our reference documentation ? >> >> more images ? >> step by step example about some general mapping task ? >> specific "How to" ? about what ? >> more details about extensions points ? which one ? >> .... >> .... >> .... >> >> Please collaborate with some ideas and will try to find a solution. >> We will use this thread to find better ideas and apply it. >> >> Thanks. >> -- >> Fabio Maulo >> >> P.S. try to avoid to transform this thread in personal discussion, each >> one has an opinion and opinions, in this case ( ;-) ), are welcome. >> >> -- >> You received this message because you are subscribed to the Google Groups >> "nhusers" group. >> To post to this group, send email to [email protected]. >> To unsubscribe from this group, send email to >> [email protected]<nhusers%[email protected]> >> . >> For more options, visit this group at >> http://groups.google.com/group/nhusers?hl=en. >> > > -- > You received this message because you are subscribed to the Google Groups > "nhusers" group. > To post to this group, send email to [email protected]. > To unsubscribe from this group, send email to > [email protected]<nhusers%[email protected]> > . > For more options, visit this group at > http://groups.google.com/group/nhusers?hl=en. > -- You received this message because you are subscribed to the Google Groups "nhusers" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/nhusers?hl=en.
