More on documentation



Hi Vadim,

you wrote in part:

> I feel that sooner or later documentation needs a major
> reorganization (Don't forget that docs - it is not only 
> "describe" but hard copy and html for browsing).  
> Modern docs sectioning is far from being optimal. 
> But I agree right now it is not our primary concern.

At the moment it seems we are working on the content
of the documentation. Maybe when content stabilizes, we
can rearrange all the blocks of text. 

> >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.

> It depends.  You already deleted some clearly outdated definitions.
> Right?  Of course any deletion must be done very carefully -
> only clearly irrelevant pieces. 

I guess I'd like to make a distinction between definitions
which are grossly out of date, which can be fixed, and 
definitions for obsolete functions, which can't be fixed.
I've deleted some of the latter, and attempted to fix some
of the former.

> My idea is was to make Maxima documentation in sync with
> Maxima reality right now with short period of time. 
> This is why I suggested to move nonworking
> parts into some temporary storage (not delete it permanently).
> One of the problem is docs translation to other Languages.
> There are people who volunteer to help (Spanish, Russian ...).
> But what these people should do with these notorious "nonworking"
> parts.  Translate them and later re-do the work when these
> parts will be finally fixed?  I really don't know.

I guess I don't see much to be gained by translating
the out-of-date documentation, because then the work would
have to be redone soon. I'll follow up with JP Romero about
the Spanish translation. I think we're making good progress
on the documentation, so "real soon now" it will be minty
fresh AND it's a dish detergent! 8^)  But there are already 
substantial parts which have been updated lately. I invite
people to look at the descriptions of save, load, ev, and 
integrate (in cvs). These still can benefit from more work,
needless to say, but I would hope that their present state
is an improvement.

Regards & happy editing,
Robert Dodier


		
__________________________________ 
Do you Yahoo!? 
The all-new My Yahoo! - What will yours do?
http://my.yahoo.com