[Typo3-typo3org] documentation.typo3.org

Michael Scharkow mscharkow at gmx.net
Wed Apr 13 22:03:47 CEST 2005

Peter Kindström wrote:

>> - how can we keep or improve usability on the typo3.org site?
>>   it would be a weird browsing experience to search the extension
>>   on one site and read the documentation on the other. 
> This *is* important. See above. We also have to consider the
> wiki/timtaw idea. Documents could be edited online...

Does timtaw exist, or is it still vaporware. And concerning the wiki: I 
really don't see a way of
a) Letting people write docs with OO
b) Making these changes editable (wiki/timtaw)
c) getting those changes back into the OOwriter file
d) all this version-controlled

without a hell of a lot of work.

> - We need documentation versioning

Subversion can handle binary files (=oowriter files), subversion has GUI 

> - It has to be easy for developers to make documentation

oowriter is as easy as it gets...

> - ...but we also have to have a good documentation format/tool
> for more proffessional document writers.

this, too, can be done with OO and a rigid template file to start from

> - Not only the author, but also the docTeam should be able to
> manage at least some of the documents.

This is a matter of managing access to version control.

The problem I see is that we want far too much at the same time: We 
should concentrate either on
a) server-side editing (=wiki/timtaw) with built-in versioning
b) client-side editing (=oowriter) with a dedicated version management

Both these require different infrastructure on documentation.typo3.org, 
not to mention the hassles of having a docteam and the gazillions of 
extension doc writers.


More information about the TYPO3-team-typo3org mailing list