[TYPO3-doc] Structure of an official document
François Suter
fsu-lists at cobweb.ch
Thu Aug 5 22:22:12 CEST 2010
Hi,
> it the head, there is twice "EXT: Name of the manual" ... is there a
> reason for it?
Yes. It's because it's picking up the latest major title, which on the
first pages is the title of the manual. In the later pages it picks up
the current chapter's title.
> This document replaces the old XYZ document. --> This would properly
> better live in Credits. IMHO, this is what credits are for ;)
It could. Other opinions?
> Looks good so far.
> I wonder whether the hints should be colored. (E.g. like the flashnotes)
I wouldn't. If you put too many colors in a document it starts looking
like a parrot. I worked in the print business for a couple of years and
I learned to limit the number of fonts and the number of colors used in
a given document. Most of these rules also make sense on the web (plus
the official documentation is meant to be printed).
Cheers
--
Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch
More information about the TYPO3-project-documentation
mailing list