[Typo3-documentation] Document progress

Jean-Marie Schweizer jms at marktauftritte.ch
Wed Jun 30 00:25:00 CEST 2004


>>> Therefor I still think we should stay with three main status, which 
>>> everyone _must_ use:
>>>   === Existing/finished documents ===
>>>   === Documents in progress ===
>>>   === Document to discuss ===
>>
>> I agree with that with the bigger documents but what about the smaller 
>> ones where such a structure is not necessary?
> 
> I dont follow you...?
> If a document is so small that it is already finished when you publish 
> it, then you just put it under the Existing/finished header right away.

Look at http://wiki.typo3.org/index.php/Debian_installation_manual

As part of the TYPO3 Installation Basics document it doesn't need the 
above structure but it needs some sort of status report so that 
proofreaders, supporters etc. know where they should start working on.

Right now the Debian Installation Manual has the status final draft 
since 20 June 2004 and is ready to proofread (grammer, style and 
ortography).

After that one of the Debian cracks like Lars, Steffen, Michael or Luc 
should read it through to make sure that it is ok from the technical 
point of view.

Then, it will get it's stable status and will be ready to be converted 
to typo3.org.

I like to get portions like that ready and then focus on other parts.

> What we now discuss is depending on how we use the wiki and there I 
> think we have slightly different opinions?

I'm not so sure if we have different opinions. We might have different 
ways of approaching the same thing which I believe is natural. So far we 
agreed on the main and important points. Where will might have different 
ideas will be a matter of time and experience to see what really works 
and what not.

> I still see the wiki as a project place where the document only exists 
> when documents are updated or produced for the first time.

> Or maybe it is used like the glossary; once in a while you take a 
> snapshot of the wiki and make that snapshot the official release. And 
> the official release for me is still the document published on typo3.org.

If Wiki does what I believe it will I see typo3.org as the snapshot 
place of Wiki for people to download a SXW or PDF document for printing 
or offline reading.

I really like Dan's idea with the snapshot of the glossary and I can see 
how it would work for everything.

> I realise that your structure in Typo3 Installation Basic is hard to 
> translate into SXW, so in that case the wiki is better. But the down 
> side of the wiki is that version control/locking is difficult since 
> everyone can change a wiki page...

That is an issue, I agree. I looked at some Wiki websites to see how 
good the quality of the articles are and if a misuse is detectable. I 
didn't see anything that indicated that people just wrote trash into 
articles although they.

> But this is no problem. IMHO these states are enought for the work that 
> is currently going on at the wiki. But maybe (probably?) that will 
> change in the future?
> 
> If so, then we change it!
> (As long as I am active in this team I probably cant keep my hands off 
> the structure and states... :-) )
> 
> What do YOU think? Should we use three main states and a few substates 
> as a start? Or?

I let you decide. I just see problems like the status thing as I go 
along and bring it up or just go with an idea that I have to find out if 
it works. And you are always welcome to just change something if you see 
a better way.

Jean-Marie



More information about the TYPO3-project-documentation mailing list