[Typo3-documentation] The_New_Documentation_Team_Process
Peter Kindström
peter.kindstrom at abc.se
Fri Jul 30 13:36:49 CEST 2004
> but I think I want to clarify that my opinion is that
> FAQ's and NG's (especially NG's) should *not* be considered documentation.
And I think FAQ but not NGs are considered documentation...
> attatched to them? For example, I buy a book for Red Hat Linux 9 ... I know
> what version it covers. I still haven't seen anybody acknowledge or address
> this diffeciency with the TYPO3 documentation.
It´s no problem since everything except the core works
"randomly". I mean a Stable extension could fail and a 0.1.2
Alpha extension could be brilliant. This community have
"learned" that testing is the only way to know... Noone trusts
version numbers anyway - at least I don´t!
A little sarcastic, I know, but worth thinking about... ;-)
The main problem (if you even think of it as a problem?) is that
each individual decides by themself. There are no central judgement.
> I agree... one interesting question though... is there an intent to offer
> documentation within the TYPO3 OOC that is directed to the end user (content
> manager)? Or only for the developer / administrator? Or is that the
> responsibility soley of the TYPO3 consultancy that is hosting the solution?
I think we should offer documentation for the whole range, from
newbie to expert, from User/Editor to developer.
But right now I think we should focus on this
- Newbie Editors and Administrators
- Middle experienced Administrators
>>At first I thought: Well, but it should be possible to write the
>>documentation so even the newbiest of the newbies would understand.
>>
>>Now, I think we should settle on some minimum requirement and improve
>>the documentation with that in mind. This should be written on the Wiki
>>and accessible to everyone. Because then we don't have many people
>>getting frustrated because they don't even start or at least they know
>>what they are getting into.
>
> I agree with this in concept... but I think setting the baseline might be
> difficult to settle on, because it all depends on how each individual
> contributor to the discussion views TYPO3 in relation to who "TYPO3" is a
> too for (e.g., Programmer or Web Designer?, Individual or Team?)
But that´s why there should be a DocTEAM... To decide when a
document is to be considered final. And to become final some
well defined objectives have to be met.
>>My goal would be to specifiy
>>
>>1. Minimum requirements of the person who wants to work with TYPO3.
>>2. Core decissions that are made in this NG. Subject to change of course.
1. I have that clear in my own head, but if you could put down
the NG's or DocTEAM´s definition, that fine with me.
2. I have thought of that for a while. It is hard to do, but not
impossible. But I think it is a bit meaningless since we have no
rules of order for how to change these decisions. Something like
this:
§1
The DocTEAM should consist of minimum three, and maximun seven
members. One of the members should be DocTEAM leader and have
the casting vote for decisions.
(Kasper is considered an additional member?)
§2
The DocTEAM has the final decision of the following tasks:
- The main documentation structure (both in wiki and typo3.org)
- When a document is to be considered final
- When a document is to deleted
- ???
Decisions of this kind, should be annonced for people to comment
at least a week before. This should be made in this newsgroup.
--
/Peter Kindström, DocTEAM
More information about the TYPO3-project-documentation
mailing list