[Typo3-documentation] Document progress

Peter Kindström peter.kindstrom at abc.se
Mon Jun 28 21:03:03 CEST 2004


IMHO too many states will make it complicated and then noone 
will use it (or dont understand and use it the wrong way). I 
agree with Dan: "I don't think the wiki should be made to be too 
formal".

Therefor I still think we should stay with three main status, 
which everyone _must_ use:
   === Existing/finished documents ===
   === Documents in progress ===
   === Document to discuss ===

They are easy for both editors and visitors to understand(?). 
Then it is _recommended_ that each document have a substatus like:
  - proofreading
  - draft
  - final review
  - published 01 aug 2004

(I dont like the 01-08-2004 since I never seem to remember which 
is the date and which is the month... ;-) )

The substatus is written in italic after the documents title. 
And I personally think it is ok if people use other status - I 
mean if someone writes "soon finished", "only TOC", "ready in a 
week" or something like that it is enought for me.


My thoughts about dates is that it is only needed in the 
Discussion page. There you write a short comment about what you 
have done in the document - and when. If we need more details 
those can always be found on the Recent changes page...
Of course it is not forbidden to date documents, but I dont 
think we should demand it...


 > The Wiki is a live environment/entity but maybe we should
 > add a "Stable" state that goes after proofreading or once
 > the document made it into a SXW on typo3.org ?

I dont think we need that, if it is under the === 
Existing/finished documents === header/status. Then it is either 
a SXW document which everyone _know_ is stable, or it is in a 
wiki page where you _never_ can be 100% sure that noone has 
changed even if it says "stable"...?


/Peter



More information about the TYPO3-project-documentation mailing list