[MITgcm-devel] 'how to' documentation

Andrea Molod molod at ocean.mit.edu
Wed May 10 18:38:22 EDT 2006


hi there,

was talking with jean-michel a bit about the peice of text
called the 'developers how to'. some of what is there is
redundant with what is in the main documentation. some of
what is there is a lovely expansion of what is in the manual,
and some is additional information.

can i ask about the rationale for having a different peice
of documentation for this part aside from the main documentation,
which has its 'how to' parts as well?

because i am proposing that we get rid of the 'how to' as a
separate entity and merge it into the manual. i propose this
with a sense that it is better to have one place for people
to look for the information they need.

i guess i am envisioning an 'evolving' manual that keeps as
current as we can keep it with the code. all that would entail
is a 'snap shot' of the manual that corresponds to the new
release that is kept somewhere available to people that want it.

thoughts?

if there are no objections i will do this.

andrea




More information about the MITgcm-devel mailing list