[TYPO3-doc] documentation format vision (wiki vs OOo)
Jakub Tesinsky
j at kub.cz
Thu Mar 8 04:02:23 CET 2007
Hello,
I think that there is some fundamental flaw in the wision of Typo3
documentation.
When I have seen typo3 wiki for the first time, I have been
automatically taking for granted that the commonly shared vision is to
convert all documentation to wiki and than give it a clear structure so
it connects well to typo3 backend application. Later on I have found
that there is no such intention and I think that this is a very wrong
thing. I am not trying to start flame here, I admire typo3 project and
the incredible amount of work put into it. And that is the reason why I
write this. Because I see huge loss of energy of documentation writers
because of not settled and agreed vision. I thing this should be
changed. I personally do have a vision, but I am far from saying it is
the best one. I simply say, that there should be SOME vision in the
whole effort.
My vision is: Put every piece of written documentation in a wiki and
then start merciless refactoring. The reason for that is that status quo is:
* There are loads of well written documents on majority of subjects
regarding typo3.
* Generally documents are long and they overlap in details.
* Usually when you are looking for some information, you find out that
several documents have useful parts - but there is no interlinking, no
clear overall structure.
I think that shows that the documentation currently needs refactoring
rather than writing new docs. And I think that wiki is right tool to do
that.
I could elaborate more on any of my statements, but I hope I have been
clear enough to show the main idea.
Keep the good work.
Jakub
More information about the TYPO3-project-documentation
mailing list