The TYPO3 Documentation Team

Our main goal is comprehensive, relevant, up-to-date and easy to find documentation about TYPO3 products for all users.

The Documentation Team sets the stage for you - the community - to write great documentation. Though we do love to write and update documentation, the purpose of our team is to provide the TYPO3 community with the tools to improve documentation.  

This includes information about using the tools to write great documentation. We strongly encourage the community to get involved. If you want to start right now, skip to the Contribute section on this page!

Contact us

The best way to contact the Documentation Team is in the Slack #typo3-documentation channel.

Register for Slack

You can also send us an email as last resort (but communication via Slack is preferred).

Slack Calls

The Documentation Team uses regular Slack calls to talk about ongoing tasks. The meetings are announced in the Slack channel #typo3-documentation

Become Part of the Documentation Team!

The Documentation Team provides the infrastructure and support to help the TYPO3 community write great documentation.

  • Documentation is important to you?
  • You would like to work on improving the technical infrastructure?
  • You like to improve things?
  • You want to help us in any way?

 Good documentation is important. You can contribute!

Contact Us!

Martin Bless

Leader

Daniel Siepmann

Team member

Sybille Peters

Team member

Contribute

If you do not wish to officially join the Documentation Team just yet, you can still contribute to the documentation.

Did you know that contributing to the documentation has never been easier? That you are just one click away from starting a contribution yourself every time you visit a page on https://docs.typo3.org? Every official manual is contained in a GitHub repository and can be edited by anyone with a GitHub account. You can also edit a page directly on GitHub. All you need for that is a browser. If you are familiar with using Git and Docker, you can clone the repository and edit and render locally instead. 

Read More About Documentation Contribution

Contribute now!

Roadmap 2019

Item

Description

Deadline

Status

New rendering infrastructure

Take documentation rendering to the next level on the new documentation server for more reliability in automatic rendering

May 2019

done

Redirects

Optimize solution for broken links and redirects

May 2019

done

"Writing Documentation"

Restructure documentation about writing documentation for contributors and extension authors. Update and add missing information. (Sybille Peters)

June 2019

done

ViewHelper ReferenceAutomatically generate ViewHelper reference from Fluid and TYPO3 source code. (Daniel Siepmann, Claus Due) 

in progress

DockerModernize Docker image. Address open issues.  (Martin Bless) 

in progress

Best practices (content)Define best practices for writing TYPO3 documentation (Sybille Peters) 

in progress

Content Strategy

Create a content strategy and a plan (Sybille Peters)

 

in progress

Content structure

Structure and reorganize content, merge duplicate content

 

in progress

Content updateUpdate content, remove outdated content 

in progress

Contributor support

Participate in events to teach the contribution workflow

ongoing

in progress

SearchGlobal search engine integration (Daniel Siepmann) 

planned

Theme

Modernize theme. Address ideas for usability and readability. Use styleguide and typo3.org as guideline.

 

planned

Start page

Optimize startpage. Evaluate idea of creating startpage as TYPO3 page (typo3.org)

 

planned

Past Achievements

You can browse through the Documentation Changelogs to see past achievements. But do note that a significant number of these achievements were contributed by community members who were not Documentation Team members. But that is a good thing because that is what we want to do: Involve you in creating great documentation.

Responsibilities of the Documentation Team

The Documentation Team provides the following:

  • Information about how to write documentation

  • Support via the Slack channel #typo3-documentation: Answer questions about writing documentation and using the tools

  • Support the TYPO3 CMS Core Team and other teams in their documentation efforts

  • Rendering of official manuals and extensions on the documentation server docs.typo3.org via automated toolchain

  • Docker image for local rendering

  • Theme

  • Organize sprints for working on documentation related tasks

  • Promote the work by writing news on typo3.org, tweeting and speaking at events

The following tasks were previously the responsibility of the documentation team and have now been redefined:

  • Translation of manuals: The Documentation Team can help others in matters concerning workflow and tools, but it concentrates its efforts on manuals in English.

  • https://wiki.typo3.org: The technical infrastructure is handled by the Server Team. Who will coordinate maintaining / migrating the content is yet to be defined.

  • https://api.typo3.org: The technical infrastructure is handled by the Server Team.

  • Writing content: Writing content must be a combined effort of the TYPO3 community.

  • Maintaining content: Content must continuously be updated and maintained. The long term goal is to put this in the hands of dedicated manual maintainers.

Documentation News

See also Documentation Changelogs on docs.typo3.org.

  • Screenshot of the docs.typo3.org homepage.

    docs.typo3.org Gets New Infrastructure

    Categories : Development , Community , Documentation
    Created by Daniel Siepmann
    docs.typo3.org is now hosted by TYPO3 Inc. and gets a modern setup using Bamboo as CI (Continuous Integration) solution for rendering.
    Read more
  • Plant, two chairs and an empty table behind a glass wall.

    Recap: Docs Team Joins typo3.org Sprint Wiesbaden

    Categories : Community , Documentation
    Created by Sybille Peters
    The Documentation Team joined the typo3.org Team Sprint in Wiesbaden, Germany from Feb 10-13. Two of us from the Docs team met up for the sprint, ...
    Read more