Björn Huber
Björn Huber submitted the idea to Improve Documentation for New Integrators and Developers, with Lina Wolf, the leader of the TYPO3 Documentation Team, heading the project.
Project Goals
By the end of Q4/2024, the goal is to restructure the TYPO3 documentation for beginners, particularly targeting integrators and developers. The aim is to help them get through the initial stages of working with TYPO3 quickly and confidently after installation.
To achieve this, the project will focus on making it easier to navigate existing documentation. Two primary areas of focus are:
- Setting up a site, including site packages, site settings, and data structures
- Working with extensions (both third-party and custom-built)
Current Progress
Lina Wolf and her colleague Maike Kiebele are making very good progress. Their plan to restructure the relevant documentation area is in place, and they are well underway with its implementation.
As a first result, the links to the version documentation in the newly introduced menu have been optimized. The latest stable version is now highlighted, while additional buttons provide access to the older LTS version and the upcoming release.
They are currently working intensively on revising the Getting Started Tutorial to make the first steps in using TYPO3 easier. New content is being created, such as instructions for setting up a root page, and explanations of the TCA. Existing content is also being reorganized or moved, such as System Requirements and Deployment in the Installation section below Getting Started; and Permission Management and Legacy Installation sections in the Administration in TYPO3 Explained section.
With the help of Sandra Erbel from the TYPO3 Documentation Team, the colleagues are also working on a glossary to better explain relevant terms in the TYPO3 cosmos.
Testing the New Structure
A test phase for the restructured documentation is scheduled for the end of November, and the project needs volunteer testers. Anyone who would like to participate in the tests is welcome to contact us in the Slack channel #typo3-documentation. Thank you very much in advance!
Benefits of the Documentation Updates
While the focus is on new TYPO3 integrators and developers, improved documentation benefits everyone. TYPO3 is powerful, but has a steep learning curve. By lowering the entry barriers, newcomers can experience early success, which brings several key benefits to the TYPO3 community:
- More newcomers will successfully complete their first TYPO3 projects.
- The community will grow as more users become involved.
- TYPO3's reputation will strengthen, attracting even more interest and contributors.
Get Involved
The Documentation Team is always looking for more support, especially for future initiatives. The team provides comprehensive, high-quality documentation for TYPO3 with help from the community. We encourage you to get involved! Reach out to the Documentation Team or join the conversation in the #typo3-documentation Slack channel.
