Re: Some more? (was: Re: My Best Ruby Documentation Suggestion)

On 8/21/05, James Edward Gray II <[email protected]> wrote:
> On Aug 21, 2005, at 7:46 PM, Benedikt Heinen wrote:
> 
> > What I'm thinking about would be to build a wiki that doesn't store
> > individual wiki pages, but rather generates the wiki pages to be
> > displayed straight from checked out rdoc; and changes to the wiki
> > page would be written back into the source and committed back into
> > the source repository.
> 
> My opinion is that being able to comment on documented methods solves
> this problem and I believe that feature is planned.

I would disagree in that comments still have to be integrated into an
article, creating an overhead as compared to entirely user-editable
material.

Still, it can be said that good documentation shouldn't require
adjustment.. but I feel that it takes a lot of commenting and updating
to get it there.

But for something like library docs (as opposed to
user-documentation).. yeah, I see how basic commenting would be the
obvious step to take.