This sounds like a very good idea; I'm just starting out with NHibernate and often don't know what the feature is that I need to look up so spend far too long hunting, having the documentation structured around solving problems should fix that.
If I can be of help with reviewing the documentation please let me know
Simon
I think this is a great idea, but also a very big one. It is like rewriting the book "NHibernate in Action".
Sure it will help newbies, and not so newbies, but probably a more "doable" task would be to just organize the excellent posts already written here (nhforge), beginning with emphasis on "Best practices".
I was also thinking some time ago writing about some "WORST practices" I have found myself doing while learning NH (still learning btw). Sort of "antipatterns" not to follow if you want to keep your heart healthy :-)
But, if I would have to add something to your schema, it would be a specific chapter about Session Management (with Windows Forms samples please).
BTW, I have no much time but I would like to help you when this starts. Some bits here and there.
Diego, I know there are many and sometimes excellent blog and forum posts. The problem for me is, it is kind of a puzzle, you need to put little important pieces together to get the picture. There are things for blogs, eg. if they are too specific for certain domains. But the rough set of features and concepts should be in a manual. A product is just much better if you know what you can do with it :-)
I already started. I built up the empty structure and just started to take content over. Sounds very easy, doesn't it?
First of all, it's amazing see this effort.... thanks for you all!
So, there are some cases a good demonstration make things clear better then text... so, i believe, when covering about session management some demos are welcome.
I believe also, in a chapter about 'Extra" things, like audit log, repository or dao approaches, nhibernate + lucene... to show how the masters do things like that.
Also, talk about uNHAddins. It has many many cool and great things, and i believe it deserves a good documentation. There are some practices theres very important like handling of business transactions, connection string encryption and much more. For beginners is hard to get a global idea about the all thing.
I think the structure looks good for a first draft. It's going to be a long slog, so keep your head up.
I've had some experience with DocBook transformations and HTML - I did some work on trying to restructure the Monorail docs into DocBook (www.symbiotic-development.com/.../html) - people didn't seem to like that much at the time as the crowd seemed to prefer the wiki everyone-can-contribute approach. It's still sitting on my backburner...
Drop me a line if you need any assistance with the transforms.