On 7/20/06, Jorrit Tyberghein <[EMAIL PROTECTED]> wrote:
> I would like to improve documentation a bit again. For that I need
> your feedback. What would you like to see documented in the
> documentation? Do you have any problems with the current structure?
> Was it hard to find stuff?

One minor change is that the sections of the manual entitled "Using
Crystal Space" and "Working with Engine Content" could be changed to
be a bit clearer in purpose to something like "Using Crystal Space
(for developers)" and "Working with Engine Content (for artists)".
It's to late at night for me to think up better names but something
that specifically mentions the two target audiences for those sections
would make it easier to figure out what the titles mean.  (After all
"Using Crystal Space" could mean running the demos.)

I'm not sure if the texinfo supports it but it would be nice if the
top node were to include the table of contents (i.e. the one that goes
down to multiple levels of nesting) or maybe just a modified table of
contents that only shows the top two levels of nesting.  The reason is
that without seeing what is under the first levels it is sometimes
hard to figure out what the top level chapter titles mean and thus
where to look for info first.  You *could* find this under the table
of contents link at the top of the page, but the CS web page links to
the "Top node" as the point of entry thus the "Top node" should be as
clear as possible for new people.

Finally it might be nice for an all-in-one-html-file version of the
manual.  It helps with printing and searching using the web browser's
built-in search.

Michael D. Adams
[EMAIL PROTECTED]

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys -- and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Crystal-main mailing list
Crystal-main@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/crystal-main
Unsubscribe: mailto:[EMAIL PROTECTED]

Reply via email to