Ayende @ Rahien

Refunds available at head office

Documentation Contributions

This is a question for the audience, assume that you have 500$, what would be the best way to spend them in a way that would improve the documentation for Castle, NHibernate or Rhino Tools?

(Just to point out, the 500$ is not related in any way to Jeff's donations, except the overall idea)

Comments

Mike
06/27/2007 08:40 PM by
Mike

Sample projects are by far most helpful for me .

Castle has some but they are often out of date (for example, trying to learn Brail is better with your sample application and not the castle samples).

NHibernate has a few good samples out there but I don't really agree with the way they consume NHibernate services since they focus on how NHibernate works rather than how NHibernate integrates into an app.

I am not sure how money would produce this unless you pay someone to commit to a day or two to create sample projects with a variety of structures and setups using these tools. I want to do just that but time keeps me from following through.

Ken Egozi
06/27/2007 08:51 PM by
Ken Egozi

What about getting all those 500$ changed to the lowest-value-coin-you-can-find (with up to 3 queries), and then write a huge I-(^^)-NHibernate through the Grand-Canyon? No that's evangelizing !!

Brennan Stehling
06/27/2007 09:30 PM by
Brennan Stehling

Perhaps the best thing you could do is purchase a very good wiki like Confluence. Since you are already running a popular open source project you can probably get a free license anyway.

http://www.atlassian.com/software/confluence/

The ease of use of their wiki actually makes writing up new documentation a breeze. It also indexes all kinds of document formats like Word and PDF and makes it all searchable. If you can get a free license you could spend the $500 on graphic designer to ensure everything looks great and is very readable. A good layout designer is worth the money, although $500 is not exactly a ton of money.

Ayende Rahien
06/27/2007 09:45 PM by
Ayende Rahien

@Brennan,

All projects already have a wiki or equivalent

Castle has http://using.castleproject.org - which is confluence

NHibernate has the JBoss' system

Rhino Tools has http://www.ayende.com/Wiki - ScrewTurn wiki

I am more interested in getting content created than the mechanics of that.

hammett
06/28/2007 01:41 AM by
hammett

I had some hard time getting up to speed with Rhino.Mocks, so I think a getting started would be useful. But who am I to complain about documentation? ;-)

Mike Minutillo
06/28/2007 02:39 AM by
Mike Minutillo

What I would love to see from Castle (and may other larger frameworks) is a separate project which goes through the construction of a complete application from beginning to end.

The project would have screencasts of important topics and a blog where contributors can talk about their experience.

This is likely going to be very time-consuming and so I don't think it is up to the core contributors of the project to do the actual work here.

Also I don't think that $500 would cover it. What it would do is increase the public exposure of the framework. It might even cause a media ruckus :)

Ayende Rahien
06/28/2007 05:20 AM by
Ayende Rahien

Hammett, did you get a chance to see the Hibernating Rhinos #1 ?

Ayende Rahien
06/28/2007 05:22 AM by
Ayende Rahien

Michael,

That is what I am doing now with the Hibernating Forums stuff. It has a different focus, but it should do to teach how you can use that.

Torkel
06/28/2007 06:02 AM by
Torkel

I agree with Mike, seeing the process of building a real world application is to me most help full in understanding how a framework should/can be used.

hammett
06/28/2007 08:52 PM by
hammett

Michael/Torkel, that's stuff for a book, not screencasts. It's just too many things involved.

Ayende, not sure I did. I really googled a lot for it. I believe my problem was handling things with no return value. Took a while to get to LastCall and understand how I was supposed to use it. But I might be getting old....

Comments have been closed on this topic.