[TYPO3-doc] Structure of an official document

[Francois Suter]

Hi all,

As we discussed recently, there are quite a few elements that must be 
placed in an official manual that would normally not appear in an 
extension's manual. It is important that we define what these elements 
are and where they should be placed.

I have made a proposal to start the discussion:

http://drp.ly/XBofK

What needs to be discussed is:

- the types of elements: do you think that some are not necessary? On 
the contrary, is there something missing?
- the names of the elements: are the various elements named appropriately?
- the placement of these elements: which ones should appear at the top 
or at the bottom of the manuals? Note that - for the purpose of this 
discussion - the table of contents should be considered as an element too.

I have based myself on a couple of books from O'reilly for placement and 
naming.

NOTE: please mind that this is not a discussion about style. I have 
example call-out boxes, because I think it's a missing feature of the 
manuals until now, but the styles and icons I applied are just there to 
indicate that these elements should stand out. They are not (yet) 
styling proposals. I hope we can get access to a designer for help on 
this topic.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch