Submit for Review

Minimum requirements

All TYPO3 Step-by-Step Guides must include the following required sections:

  • Title — Starts with a verb and reflects the overall learning objective
  • Conceptual overview — Follows the title directly (no heading), uses plain language, and stays under ~100 words
  • Learning objective — Describes what the learner will achieve by completing the guide
  • Prerequisites — Lists required software, tools, environments, and any conceptual knowledge

  • Task section

    • Includes at least one task with numbered steps
    • Each step begins with a verb and describes one action
    • Each task includes at least one expected outcome
  • Summary — Recaps what has been achieved
  • Next steps — Suggests logical follow-on tasks

The following sections are optional but strongly encouraged:

  • Resources — Links to supporting material
  • Video — Embedded video version of the guide (from the official TYPO3 YouTube channel)

Use the template and writing instructions to complete each section.

All required sections must be complete and free of placeholders like “TBD.”

Every guide will have room for improvement — that’s expected. That’s why all TYPO3 step-by-step guides include a feedback section to collect reader-reported gaps and issues.

Definition of done

A step-by-step guide is ready for submission when:

[ ] All required sections are complete — no placeholders. [ ] Numbered steps are logical, testable, and lead to the expected outcome [ ] Screenshots or code examples are included where appropriate and follow TYPO3 guidelines. [ ] Relevant concepts or references are linked where needed [ ] Language is clear, concise, and action-oriented [ ] The guide has been tested by the author [ ] The guide follows TYPO3 writing conventions and formatting rules [ ] The guide fits its intended scope. (One learning objective per guide, or a project guide for more complex, multi-step processes.)