About the Documentation

From TYPO3Wiki

<< Back to Teams page   (edit)

Information about the documentation team, projects, web pages, how to contribute and things like that. It also is the place where the DocTEAM keeps their notes, todos and discussions. Feel free to join!

Overview

There are different opinions about what should be considered TYPO3 documentation. On TYPO3-wiki we consider this in our Document Matrix to be documentation:

• OpenOffice/SXW and PDF documents on typo3.org
• Information on the wiki
• Information on typo3.org documentation pages
• FAQs, HowTos and Tutorials and a general description of Extensions

Note that newsgroups/mailing lists are not considered documentation and therefor we should get information from them and put into various places in the "real" documentation.

Writing documentation

How to write documentations; the rules, templates, tips and tricks. Also something about why we write documentation in a certain way.

• General guidelines on how to write documentation
• Wiki guidelines for editing and creating wiki pages
• Information about images in documentation
• Writing in an alternativ language
• About problems and resolutions in the documentation process
• Suggested workflow when writing documents
• How to use Wink to make small flash tutorials
• How to upload Open office documents to typo3.org
• Tips and tricks about writing documentation
• The documentation should be well structured
• There are ready made templates to use for pages

If you want to help with documentation, please take a look at the Documentation joblist and then contact the DocTeam for more information!

TYPO3 DocTEAM

TYPO3 has its own documentation team. Their responisbility is to have an overview of all the documentation on TYPO3-wiki (mainly the structure), to see that things as progressing and that important information is not deleted.

• DocTEAM news
• Guidelines / DocMeetings
• About the DocTEAM
• This is our current todo-list -- see also Current activities

You can contact us via the official documentation mailing list or news group. (They both have the same content and are synchronized.)

Other pages

These links should be organised and maybe integrated into other pages in the future:

• Wiki guidelines
• Read/download Kaspers view of the TYPO3 documentation: TYPO3 Documentation Organization
• Page about the wiki structure
• The Documentation Introduction
• Doc Web Pages
• The Sourceforge development docteam project
• Maintenance - Regular maintenance keeps the documentations alive. This section is meant to be a reminder for the writer when to think about maintenance and what to do.