[Bioperl-l] Re: Developing Improved Bioperl Documentation

Kris Boulez krbou@pgsgent.be
Thu, 14 Dec 2000 09:29:33 +0100

Quoting Peter Schattner (schattner@alum.mit.edu):
> Hello Kris & Brian
> I gather that the two of you have volunteered to develop improved
> documentation for (release 0.7 of) Bioperl.  I would be glad to
> contribute to this important task assuming you could still use some
> help.  
I think we certainly can. Real life always takes more time then expected

> I think that a good starting point would be a proposed outline /
> table-of-contents for the documentation.  That would make it clear what
> topics would be covered and should make it easier for people to sign up
> to write different sections.  Has either of you written such an outline?
>  Or have you been envisioning a different way of organizing the work?  
> If you have written an outline, could you send me a copy?  If not (and
> you agree that having an outline might be useful), Id be glad to take a
> shot a writing one.
I don't think something like this exists yet.

My plan is to start writing cookbook-like documentation (see an earlier
mail from Ewan), based on the SYNOPSIS part of each module's
documentation. In the mean time chekcing these section for correctness.