This is the mail archive of the guile@cygnus.com mailing list for the guile project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: generating a manual from annotations in source code



I fully agree with Jim on all his points about generating docs from
source.

I think that the real problem with Guile docs actually had to do with
defining the product and its major categories more clearly.

Jim and Tim and I and others had made several good starts at
reorganizing the manual, but after a while we never felt that the
manual's structure was quite right, and after a while we would have
trouble getting motivated to do any detail work.

I sometimes think the best thing might be to just write a long list of 
chapters on rather fine-grained topics, and end up with a manual that
has 30 or more chapters but no hierarchy beyond that.  That would be a 
good start, and the organization could improve later when people
figure out how to break it up into more coarse-grained categories.