More on documentation



Hi Vadim,

Thanks for your recent work on the Maxima documentation.
It really needs a lot of work! That said, I guess I recommend
an incremental strategy rather than major changes all at once.
I'm inclined to keep the everything in a workable state
all the time.

I agree that the organization of functions into .texi files
is somewhat haphazard. However, since the organization of
functions by file has little effect on the "describe" output,
I would steer away from large-scale changes to address
organization. There are some "Definitions for ..." @nodes
in the .texi files, which comprise a large number of functions;
I guess some functions should be moved so that each function 
falls under an appropriate "Definitions for..." heading.

I guess I would recommend against moving descriptions of
broken functions, and broken descriptions of working functions,
into a special directory. I would rather leave the descriptions 
and file bug reports as needed. I would claim that even the 
out-of-date documentation is useful.

Moving None.texi and xrefs.texi into the archive directory
makes sense to me.

I share your concern for the documentation -- that's
why I'm working on it -- but I guess I don't feel the same
urgency; some parts have been out of date for many years, 
so it can't be too important to fix them.

Incidentally, my own bias is to revise the parts of the 
documentation which are most needed by new users. 
This (I'm guessing) is stuff like saving & loading files, 
using the debugger, other command line stuff, etc.

regards,
Robert Dodier


		
__________________________________ 
Do you Yahoo!? 
Meet the all-new My Yahoo! - Try it today! 
http://my.yahoo.com