[Gardeners] Project Proposal: Gardeners Documentation

[Peter Seibel]

On Jan 8, 2006, at 11:37 AM, Cody Koeninger wrote:

> http://wiki.alu.org/Gardeners_Documentation
>
> Let me know what you think . . .

For starters, you should probably adjust that page to follow the  
organization pattern of:

  Champion
  Proposal
  Volunteers
  Tasks

and then other stuff as needed. (That may not be the perfect format  
but it's probably handy to have the project pages organized more or  
less the same and that seems at least a reasonable organization.)

To the actual content, I'd like to see more concrete ideas about how  
you're going to proceed. For instance, I'd rather see a proposal to  
document a few specific packages using different tools and then  
evaluate the results rather than a general plan to, "[g]et a rough  
agreement on minimum guidelines for what we want to see in  
documentation." Not that you shouldn't do the latter, just that I  
want to know how you're going to go about doing it. You can also talk  
about any resources you need so we can see if we can help out--for  
instance if you want, we can host sample documentation on  
lispniks.com in the early stages and full documentation there later,  
if that makes sense.

Another way to put this (which applies to all project proposals) is  
that I'll be more likely to give a +1 to a project that says, we're  
going to start with small concrete step X and then figure out the  
next best thing to do, than one that says, first we're going to  
figure out a grand plan for steps 1-20 of this project. Not that your  
proposal is quite as extreme as that.

Anyway, this is a good start, if you can make it a bit more concrete  
and attract a couple volunteers I'll be happy to give it a +1.

-Peter

-- 
Peter Seibel           * peter at gigamonkeys.com
Gigamonkeys Consulting * http://www.gigamonkeys.com/
Practical Common Lisp  * http://www.gigamonkeys.com/book/