Re: What's an annex? stratum?

Robert Dewar
2007-06-25T20:40:53Z

Michael Eager wrote:

> Internals documentation provides a guide through the program in
> some kind of logical order. It's difficult to provide that order
> at the file or function scope.

Well the sources can provide a clear logical order,
e.g. the child hierarchy and the separate specs and bodies in an
Ada program. Anyway, see the GNAT front end, where by policy there
are NO separate design documents, for an indication of what I
consider ideal, or almost ideal (probably one short page of the
form .. start here, then ... would be helpful).
>
>> But in any case, if internals documentation existed in the sources,
>> I'd be a happy camper.
>
> Me too.
>