If I may throw in my two cents as a user of NHibernate ...

The Docbook is well-written and organized but sometimes you just want
to see how a specific method call works or what a particular class is
for.  Maybe an HTML Help file based on XML Comments from the source
code would be beneficial?  They can be automatically generated with
Sandcastle and are a relatively minor amount of work.

I would contribute but I don't think I have sufficient knowledge of
NHibernate to be able to contribute effectively.


On May 15, 3:56 am, Stefan Steinegger <[email protected]> wrote:
> In a thread with Fabio Maulo (http://groups.google.com.ar/group/
> nhusers/browse_thread/thread/256e8a8a9958f939/
> a41a81c21a26fb03#a41a81c21a26fb03) we went off on a tangent and came
> to the documentation problem. Here is a summary:
>
> * many things are hardly documented
> * the documentation is there (eg in blogs and forums), but could not
> be found (it's like a puzzle)
> * Contributers are needed to split up the effort needed
>
> Thats what we have:
> * nforge.org has a wiki, but there isn't much documentation except of
> a part of the well known reference documentation.
> * An knol by Fabio with the complete reference documentation of NH
> 2.0. I found out that it is free to be edited for everyone, but I
> doubt that anybody else ever contributed to it.
> * this google group
> * Excellent posts by Ayende on his own blog and on nhforge.org.
> * hundreds of blogs from many other people for specific topics.
>
> I would like to have a documentation that is
> * somewhat complete and detailed about NH's features, syntax and API
> * It must be always clear which version of NH is concerned
> * A documentation of a version should not only document the difference
> to an older version, it should be complete in it's own.
> * As much as possible it should be sequentially structured, like the
> reference documentation, unlike blogs.
>
> My question is:
> * Should we, as a community, build up a complete documentation?
> * How should this be done? It must be managed, structures must be
> defined.
> * Where should this be done? On nhforge's wiki?
> * How do we attract potential contributers?
> * Last but not least: would you contribute?
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---

Reply via email to