logo       

Re: Call for help: documentation: msg#00104

lang.ruby.capistrano.general

Subject: Re: Call for help: documentation

Great idea. Jamis thanks for all your hard work on capistrano.

I'd like to put a vote in for the documentation being maintained via a
wiki. Now, don't get me wrong, I know we've all seen a lot of really
poorly organized and sloppy open source documentation wikis out there.
But I think that this problem could be easily solved by having a
dedicated wiki gardener, who only contributed (and enforced) structure
/ organization / categorization, within which the other documentation
contributors could work. I think that the person(s) described in point
1 in Jamis' email could fit into this role.

From anecdotal evidence I feel pretty strongly that effective
documentation needs to be a wiki. The Rails wiki is an example of
documentation that is poorly organized but still provides useful
answers in google searches. The prototype documentation is an example
of non-wiki documentation that is... limited.

Clearly, an ideal grand finalé for my statement would be an example of
a well-organized documentation wiki, but I can't think of one :-D

Anyone else have examples of good and bad documentation
implementations in various media?

John

--
John Joseph Bachir
http://lyceum.ibiblio.org <--- has poorly maintained documentation wiki :)
http://blog.johnjosephbachir.org
aim/yim/msn/jabber.org/gtalk: johnjosephbachir
713-494-2704
http://jjb.cc

--~--~---------~--~----~------------~-------~--~----~
To unsubscribe from this group, send email to
capistrano-unsubscribe@xxxxxxxxxxxxxxxx
For more options, visit this group at http://groups.google.com/group/capistrano
-~----------~----~----~----~------~----~------~--~---

<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise