[TYPO3] Documentation nightmare

Dan Osipov dosipov at phillyburbs.com
Fri Mar 14 17:58:01 CET 2008


My problem with that is that the developer documenting his work knows 
too much about his development, and makes assumptions that some 
knowledge can be ommited. As a result, the document has lapses, and 
newbees can't follow it. This is the case with most of the documentation 
on the site (Inside Typo3, etc). Furthermore, the problem of broken 
links I mentioned, makes it really hard to find in depth information on 
the subject briefly mentioned.

And again, since there is  good versioning system built in to the wiki, 
the editor can always roll back the changes, maybe responding to some 
users concerns.

Dan


Dmitry Dulepov [typo3] wrote:
> Dan Osipov wrote:
>> I actually prefer the wiki - people can make modifications and correct 
>> any errors in the article. They can discuss the article contents in 
>> the discussion section, and ask for help. Changes can be tracked 
>> through an RSS feed, much harder to do in the OO files.
> 
> I do not think this is a right way to write docs. Doc should be written 
> by author and reviewed by editor... Imagine TYPO3 Core API written by 
> many people, it will be chaos.
> 


More information about the TYPO3-english mailing list