We can categorize these issues to give an indication of the effort and action required.
No Docs Required
Some changes need no documentation beyond the entry in the Changelog. For example,
- If a hook or API method has been removed that was never documented in the References orTutorials in the first place.
- If a Feature includes changes to the GUI that does not need to be documented.
Action: We can just close these issues.
Some changes need to be documented within the TYPO3 Core mono-repository. This includes:
- Changes to system extensions that have their own manual (for example, form, adminpanel, impexp, etc).
- Documentation that is automatically generated from source code (for example, Fluid ViewHelper Reference, the API of a new Event).
Action: We can link the Forge ticket to these issues.
Expertise Required Docs
Some changes impact documentation that falls in a particular field of expertise, or an area of functionality.
Action: We can tag these issues, then group them and work on documenting them as a batch.
How You Can Help
Come join the Documentation Team! We are much more fun than our name might suggest! You do not need to be an expert to help us.
We need people to help tag issues, and follow up to remind those who worked on a ticket when there has been no action.
We need help with reviews of the English language (hard to learn), and ReST syntax and semantics (easy to learn).
You can help us by reviewing anything from no-brainer pull requests to trickier PRs where you need to keep trying to find someone who has knowledge on a new topic.
You can help us by applying best practice throughout the documentation; and by trying to find out what is best practice.
To whet your appetite, here is a sample of open questions in the Documentation Team:
- How do we hint at dependency injection in small code snippets of a few lines, without any class context?
- How can we convince people to use sitepackages and not store their Fluid template in the fileadmin, and the TypoScript in the database?
- Should extension developers use Extbase; and how to properly develop an extension without Extbase?
You can make a real difference here! Come along to one of our meetings held on the third Friday of every month, or add your voice to the conversation in the #typo3-documentation Slack channel.