Re: Documentation

From: Rayiner Hashem (heliosc_at_mindspring.com)
Date: 10/04/03 

Date: 4 Oct 2003 11:52:42 -0700

> I'd recommend LaTeX. It's easy enough to get started using, and
> waaaaaaaay better than XML. *TeX's syntax is odd, but XML managed to
> out-crap it by a few orders of magnitude. If you want to include code
> in your docs, use noweb (a lit programming tool). Using various
> tools, you can produce hyperlinked PDFs, and html.
Cool.

> Oh, you're talking about *that* level of documentation? It's easy
> enough to write a loop and calls to DOCUMENTATION, to pull this out of
> an image, and dump it to a skeleton in whatever system you choose.
> Use noweb.
Like like to have documentation at both levels. I find little point in
documenting tiny details in the high-level docs, which can easily get
out of sync, and don't like to put high level stuff in the comments
themselves, because that's a really poor medium for writing.