[TYPO3-doc] documentation format vision (wiki vs OOo) [update]

Jakub Tesinsky j at kub.cz
Mon Mar 12 01:20:15 CET 2007


Thanks for your patience with me, I see your arguments. I was not aware 
of reviewing-extension. I think that in a) there are two differencies:
  1. the quality of written docs and I agree with you that currently OOs 
are better in that than wiki, but I believe that it can change in time 
if wiki is developed properly.
  2. the medium and the ease with which it can be serched and browsed. 
In this matter I also believe that wiki - given the right navigation 
structure, should be better in long term.

Also I belive in step by step developement which substitues notion of 
reviewing in wikis, but this is probably matter of personal belief. In 
this sense I consider wiki having better potential both in a and b.

Also I consider your three points as expression of priorities of 
community which I did not know before. For example for me the crucial 
priority would be B, because if you ease the possibility to extend the 
documentation you (in long term) greatly enhance overal quality of 
documentation and therefore ease of use for something you want to be 
done is also enhanced.

I still do not understand what exactly is the intended future 
developement of wiki. Is (for example) transferring and refactoring of 
different tutorials using wikiengine something what fits with this picture?

Jakub


> Hi Jakub,
> 
> everybody has three roles
> * a) use documentation for something you want to be done
> * b) extend/ create new documentation/ translate documentation
> * c) rate or review documentation
> 
> A wiki -- as a tool -- is very good in b), very bad in c and it's OK in a)
> 
> Browsing and searching through XHTML-rendered docs are optimal for a)
> and combined with the reviewing-extension on typo3.org c) is optimal, too.
> 
> OO-docs are very good, when docs must be "one piece", versioned and
> delivered with an extension.
> 
> U understand?
> 
> kind regards
> Daniel Brüßler
> 


More information about the TYPO3-project-documentation mailing list