[Adium-devl] Bus factor

Augie Fackler lists at durin42.com
Wed Aug 1 20:39:02 UTC 2007


Documentation either in subversion or on the wiki. The subversion  
project has a great amount of docs that record the what (and often  
the why) of what they do, so that things are well documented. Examples:
http://svn.collab.net/repos/svn/trunk/notes/schema-tradeoffs.txt
http://svn.collab.net/repos/svn/trunk/notes/changelist-design.txt

Note that documents like this are in addition to OCD-quality API  
docs, both internal and external. These are the why and elements of  
the how (example: the wiki page I asked Evan for about how the  
contact list works [1]). In general, anyone should (via either a wiki  
page or an in-repo text file and some in-code docs) be able to figure  
out the structure of a feature and (presumably) extend it. I was able  
to go diving right in to a feature on subversion and write a patch  
with minimal handholding because things are well documented.

Peace,
Augie

[1] http://trac.adiumx.com/wiki/ContactListDesign

On Aug 1, 2007, at 3:24 PM, Chris Forsythe wrote:

> Guys,
>
>     Right now we have a ton of bus factor within the project. For
> instance, who here knows the complete release process anymore (not  
> me).
> I would like to get some of this to disappear by documenting things
> which can be documented, and that sort of thing.
>
>     So, what can we do to help resolve this?
>
> Chris
>
> _______________________________________________
> Adium-devl mailing list
> Adium-devl at adiumx.com
> http://adiumx.com/mailman/listinfo/adium-devl_adiumx.com





More information about the devel mailing list