how to improve existing documentation (review it). What might be a good workflow?
how to keep track of what is already up to date / reviewed?
Aspects of reviewing:
in order of importance (roughly)
technically correct, up to date, adheres to best practices
didactic : easy to understand. Does it walk the reader through all steps (e.g. for a howto guide)
helpful is the documentation generally helpful?
structure and findability: structure of menu, topics easy to find. Linked from start page? SEO. Is the menu consistent throughout the docs so things are easily recognizable (e.g. placement of sitemap)
formatting: does the formatting make it well readable and skimmable. Is the formatting consistent throughout the docs so similar things are easily recognizable
enough and not too much (should this be documented? Is this something which can be easily looked up in the core? Would documentation be even necessary if the GUI or the API were improved? Should we rather focus on that?
There is already a resources page: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/Resources.html#resources
I would like to collect some more resources here.
Plan documentation writing
Documentation structure
These are some questions / classifications:
Tips:
Other documentation (with good structure)
Good ideas:
Writing good content
Style Guides
Maintainance and Reviewing
Aspects of reviewing:
in order of importance (roughly)