[Biococoa-dev] Developer documentation

[Charles PARNOT]

At 2:39 PM +0100 2/23/05, Alexander Griekspoor wrote:
>Now, I do realize that with the arrival of more people, it's obvious that they are gonna ask themselves and the list (no offense, please do!) the questions that we asked ourselves as well during the initial design of the setup we now implement. Therefore, I think that once the basic BCSequence system is up and running (BCSequence et al, annotations & features, and SeqIO) documentation will become the number one priority. As I want to do spend a bit more (PR)  words on BioCocoa on our website anyway, to generate more knowledge and traffic. I'll see if I can combine that with some more explanation of the basic architecture of the BCSequence setup. Until the 1.0 release of BioCocoa and if anyone agrees with the idea, it can become the temporarily (developer) homepage of the new BioCocoa framework, leaving the current one intact as long as we're still in beta (or alpha ;-) phase. Peter, any thoughts on this one?

Yes, this is why I started the dev-docs folder on the project. Having it in the project makes it easier for everybody to edit, like a wiki in a way, so everybody can contribute and help too. To duplicate this in a web site is nice, but it might be hard for you to keep it in sync? Maybe if you suggested a simple layout that would make the conversion easier? e.g. I sticked to some <h2> and <p> tags in what I started (I did not like the default format for <h1>, too big!).

I know by experience from working with you that the web page will look fantastic no matter what, so I do think it is a good idea... i just want to make sure you don't spend too much time on it and that everyone can help. And also let's remember: most of the 'developer doc' should be in the implementation files themselves, in the good old /*comments*/ which are sooo important to edit and debug somebody else's code.

Again, just my 2 cents :-)

charles

-- 
Help science go fast forward:
http://cmgm.stanford.edu/~cparnot/xgrid-stanford/

Charles Parnot
charles.parnot at stanford.edu

Room  B157 in Beckman Center
279, Campus Drive
Stanford University
Stanford, CA 94305 (USA)

Tel +1 650 725 7754
Fax +1 650 725 8021