Here's a thought:
everyone who commits code to the trunk also has to add documentation about
that code to a documenation repository and has to make sure the committed
code is xml documented so reference documentation can be generated easily.
FB
> We still waiting the explication from the issue-owner gwapo1000.
>
> The "without a big business-monster behind it" is there because I would
talk
> about something feasible where the definition of "done" is clear. A link
to
> the MSDN will result in a utopia and I will be out from that discussion.
>
> I have invited all users to collaborate with the documentation more than
one
> time, we all have:
> http://knol.google.com/k/fabio-maulo/nhibernate/1nr4enxv3dpeq/21#
> http://nhforge.org/wikis/
> Clean-up of API documentation http://216.121.112.228/browse/NH-1467
> And some others patches about reference
> (http://nhforge.org/doc/nh/en/index.html)
> A user wrote some documentation in google-doc but I can't find the link
> Obviously 4 books (http://nhforge.org/content/Books.aspx)
>
> In practice there are many public and open way to write documentation but
> very few people working in it... so even if we can talk about it a lot, I
> prefer to talk about clear and feasible targets (concrete & pragmatic !=
> rude).
>
> P.S. In the future I would see the guy affected by the supposed "rude"
> answer saying that I was rude, instead read the interpretation of some
> "lawyers" defining me rude only because his suppositions.
>
> On Tue, Sep 28, 2010 at 7:25 PM, Oskar Berggren <[email protected]>
> wrote:
>
>
> Hi Fabio,
>
> I guess it was the part about "without a big business-monster behind
> it" that I failed to see the relevance of, and because of it my mind
> then jumped to conclusions about your motives. Apparently my
> interpretation was wrong. My apologies.
>
> My contribution so far is limited to trying to answer questions on
> nhuser.
>
> /Oskar
>
>
>
> 2010/9/28 Fabio Maulo <[email protected]>:
> > I'm asking too.
> > I don't understand which kind of documentation gwapo1000 is
looking
> for.
> > Oskar, which is your problem ? why my questions are not polite ?
> > I'm asking to gwapo1000, perhaps he can send us a link, an example
> or a more
> > clear explication of the documentation he is looking for.
> > I have personally wrote some docs, and I have personally re-
> designed some
> > diagram as I'm personally deployed the API-docs using SandCastle.
> There are
> > some users helping us with the improvement of documentation (the
> last one
> > was Diego Mijelshon) creating issues and providing proposals.
> Instead waste
> > your time defining what is polite and what is not polite perhaps
> you, Oskar,
> > may do something.
> >
> > On Tue, Sep 28, 2010 at 4:05 PM, Oskar Berggren
> <[email protected]>
> > wrote:
> >>
> >> Please Fabio, he was only asking politely. It seems unreasonable
> to
> >> demand proof that some other OSS project have documented their
> >> internals before you are allowed to ask if such information
> happens to
> >> exist for this project. Surely the usefulness of such
> documentation
> >> doesn't depend on some random other project having that kind of
> >> documentation?
> >>
> >> Reading source code is useful, and must ultimately be done to
gain
> >> full understanding, but having a high-level map of the forest of
> >> details isn't worthless. IMHO.
> >>
> >> /Oskar
> >>
> >> Ps. I'm not suggesting that someone unpaid _must_ write such
docs,
> >> unless they want to.
> >>
> >>
> >> 2010/9/28 Fabio Maulo <[email protected]>:
> >> > For example ?
> >> > Have you an example of the documentation you are looking for
> with a link
> >> > to
> >> > those docs of another OSS project without a big
business-monster
> behind
> >> > it ?
> >> >
> >> > On Tue, Sep 28, 2010 at 2:05 PM, gwp <[email protected]>
> wrote:
> >> >>
> >> >> Hi, i would like to learn nhibernate internals, and therefore
> im
> >> >> trying to find some documentation for nhibernate source code.
> Most
> >> >> class contatin only briefly description, i would like see for
> example
> >> >> some diagram, some pattern usage , more technical
> infrormation.Of
> >> >> course i can read source code, but without proper information
> its very
> >> >> difficult task. If anyone know if such docs exists? or
> documentation
> >> >> is only in source code and mailing list?
> >> >>
> >> >> thanks in advance.
> >> >
> >> >
> >> > --
> >> > Fabio Maulo
> >> >
> >> >
> >
> >
> >
> > --
> > Fabio Maulo
> >
> >
>
>
>
>
>
> --
> Fabio Maulo
>
