[TYPO3-doc] Experimenting with ReStructured Text

Fabien Udriot fabien.udriot at ecodev.ch
Fri Jul 29 09:21:04 CEST 2011


> Once FLOW beta1 is out of the door, they will write about their experience in this mailing list. We
> will then have a debate whether we stick to DocBook or switch to ReST.

Good. Let see how far this experiment goes.

I must say, according to my experience, people don't feel very confident with DocBook and its 
learning curve which is not to be under-estimated. To be honest, I feel like it will put off people 
writing documentation instead of helping. For instance, the slow progress of the Extbase Book 
Translation is partially due by the fact people has to learn a syntax and dive a rather "complex" 
tool prior to think of the content itself... Since we have put the translation in a wiki format, 
people started to translate more.

Docbook has advantages but also drawbacks as pointed out: "verbosity", "complexity", "lack of easy 
tools for editors".

I am aware it is too early to start the debate and we have to wait the outcome of this ReST 
experiment but if it is proven we can have the same benefit with a ReST syntax as DocBook, I won't 
complain of the switch ;)

Fabien


More information about the TYPO3-project-documentation mailing list