Re: Cast of Characters and Credit

On Aug 30, 2006, at 12:52 PM, James Britt wrote:
> Eric Hodel wrote:
>>> Who are the folks writing docs?  And who else deserves credit  
>>> for  one thing or another related to ruby-doc.org or the doc  
>>> process?     (Aside from authors of standalone content on the  
>>> site; the names  are attached to the items, unlike most rdoc stuff.)
>> When checking in documentation I add names to the ChangeLog of  
>> the  submitter.
>
> But these names don't appear in the docs themselves, so most people  
> have no idea who to thank.

Maintaining a documentation ChangeLog per file will duplicate  
everyone's work.  There is no precedent and you'll force everyone to  
scan through every file looking for committers.  Adding attributions  
to the documentation per comment block will suffer from a magnitude  
problem (how big a change is worthy of a mention?) and a clutter  
problem.

The best place to list everyone's contributions is the ChangeLog.

-- 
Eric Hodel - [email protected] - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com