[TYPO3-doc] Structure of an official document
François Suter
fsu-lists at cobweb.ch
Wed May 12 15:26:24 CEST 2010
Hi Philipp,
Thanks for your feedback.
> dedications should be left out, because the docs are for the community.
> For sure it would be nice to preserve Kaspers dedications somewhere, but
> I don't think they should be keep forever in the official manual.
> Maybe Credit could be the last point and include a list of authors (or
> maybe just a wiki link which hold the information then).
OK. Seems like dedications are pretty dead ;-)
> Something I miss too is any information regarding translations. "Core
> Manuals" should not be translated, but "Guides" and "Tutorials" might
> get translated into other languages. I would like to have a statement
> (just in translations) that the translation might not be up to date and
> only the English version is supported and "peer-reviewed".
Good point.
> The front page is half empty - this is a general problem of all manuals
> - maybe there could be something.
Yes, but what?
> Table of contents should always start at the second page.
Agreed.
> The "warning" and "tip" boxes should get better graphics, at least with
> transparent background ;)
As I said, these are not styled yet. Personally I think that a very
light background might be nice. I tried to apply a 5% grey in
OpenOffice.org, but I found only a predefined 10% grey and couldn't find
how to change the palette...
I hope to have someone from the design world look into that, if one
deigns look at lowly word processor documents ;-)
> BTW, I miss specific styles/boxes for code. This should be formated
> always the same ways.
True.
Cheers
--
Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch
More information about the TYPO3-project-documentation
mailing list