[Typo3-doc] hebrew documentation

Sylvain Viart sylvain at ledragon.net
Fri Dec 17 07:21:24 CET 2004


Hi Zorik,

Zorik Pavlenko wrote:

>>programming behind it, is pretty heavy. We, at the DocTEAM, are working
>>on the TYPO3 documentation redesing on the Wiki.
> let me see if i get you right - wiki will not be used to provide manuals, 
> but will serve a development platform for manuals, which will be provided on 
> typo3.org???

Not exactly, in fact. But that's the way.

Before the wiki every manual must be written in SXW. A lonely person was 
working on it and no one has chance to help him. Unless he share it and 
they use OpenOffice revision/version control sending the new version to 
each other.

Now we can work online on the Wiki which has a great version control 
system, and a simple syntax.

But the problem is that for the moment, we have nothing more than human 
control to watch the document on the Wiki. And most of the document on 
the wiki are draft changing when people have time to contribute.

But the recent discussion in this list have raised that there's not the 
main problem. We should first work on the Documentation structure before 
fixing our tools.

The Wiki does provide documentation, but there will be draft only. Still
for some times...

So the next step would be to have a staging system to lock finished 
document. It is not defined for now.

> maybe. first i have to understand what you're doing.
> are you creating information framework for existing and future 
> documentation?

Yes, but not at tool level for now, only at documentation level. We are 
gathering idea and documentation and try to organize all that.

> or ready to use informational structure? by who?

That's our goal, to have the TYPO3 documentation well structured. We are 
a small group of volunteer.

> or coding for the framework?

To my knowledge, no one is coding for the documentation right now.

> thanks. before 'doing' comes 'planning' - how do you plan stuff - how do you 
> collaborate?

We plan stuff, here on this list and try to wrote down the result on the 
wiki at the same time. Next I keep the volunteer's name in the bug 
tracker and ask them for time time to where they are in their task and 
what help they need.

The main difficulty is to having the people.

> the main bottleneck is not the multibyte support, but that manuals has to be 
> identical, or at least similar, to english ones. dont you think so? it would 
> make chunking information and its management much easier

So about translation we discussed, that the english should be the main 
production language for official document. For client oriented manual 
that's different.

Because they have to be first written for customer, in their own 
language. English translation come later.

But all our effort should be now on the document structure, not on 
translation.

But you may have a different idea to make our work more efficient ?
-- 
Regards,
Sylvain Viart -- TYPO3 DocTEAM.
http://wiki.typo3.org/



More information about the TYPO3-project-documentation mailing list