[TYPO3-doc] Redefining the missions of the Documentation Team

Martin Holtz typo3 at martinholtz.de
Thu May 13 13:10:50 CEST 2010


Hi,

> <quote>
> The Documentation Team aims to provide exhaustive, quality documentation
> about TYPO3 for both beginners and advanced users, with the help of the
> community. In order to achieve this, it pursues the following goals:
what are "beginners" and "users"? 
Do we take care about editors?
If yes, is CSH something we should have in mind?

Or do we only focus on that people, who install and manage TYPO3 (admins) or 
writing Extensions (developers)?

And you defined different types of documentation. I think we should 
integrate it here.

The Documentation Team aims to provide exhaustive, qualtiy Tutorials, Guides 
and Core Manuals about TYPO3 for editors(?), admins and developers, with the 
help of the community. 
 
>     * write and maintain official documentation, whose quality is
> ensured by peer review
+1

>     * provide a tool for the participative creation of documentation
>     (wiki) 
* maintain (and organize?) wiki.typo3.org to have a low entry barrier for 
writing documentation

>     * care for the "Documentation" section of typo3.org and any
>     other
> relevant pages
+1

>     * support the TYPO3 Core Team and any other team in their
> documentation efforts
well, what should that mean? IMHO not clear enough

>     * provide on-line tools for easy reference to TYPO3's main languages
> and APIs
* maintain on-line tools for easy ...
i think, it should not be the main task of the documentation team, to 
provide (create) such an tool. Perhaps its an lack of english skills on my 
side in this point, but i understand provide that way, that we create such 
an tool. It should be ok, if we do it - but it should not be an central 
task. Maintaining such an tool should be an central task.

>     * create and maintain any other tool which favors documentation and
> understanding of TYPO3
the same as above - i am not sure, if creation of tools should be an 
important task of the documentation team. Its ok, if we do it - but it 
should not be a main task of the documentation team to write code.

> </quote>

Thats my thoughts.

But in my eyes, that are minor changes - so i would be fine with the 
original version.

regards,
martin

-- 
http://blog.martinholtz.de
http://wiki.typo3.org/Ts45min - TypoScript in "45" Minutes
http://wiki.typo3.org/De:ts45min - (auch in Deutsch)


More information about the TYPO3-project-documentation mailing list