TYPO3 Documentation Skill

Create and maintain TYPO3 extension documentation following official docs.typo3.org standards.

Core Workflow

1. •Run extraction first to identify documentation gaps:
   bash

   scripts/extract-all.sh /path/to/extension
   scripts/analyze-docs.sh /path/to/extension
   

2. •Consult the appropriate reference file for the task
3. •Use TYPO3-specific directives, not plain text
4. •Validate: scripts/validate_docs.sh /path/to/extension
5. •Render: scripts/render_docs.sh /path/to/extension
6. •Verify rendered output and README/Documentation sync

Critical: When the user asks to "show docs", render and display HTML output, not raw RST.

Element Selection Guide

Critical Rules

• •UTF-8, 4-space indent, 80 char line length, LF endings
• •CamelCase file/directory names, sentence case headings
• •Index.rst required in every subdirectory
• •PNG screenshots with :alt: and :zoom: lightbox
• •.editorconfig required in Documentation/
• •Screenshots MANDATORY for backend modules, config screens, UI workflows (see references/asset-templates-guide.md)

Pre-Commit Checklist

1. •.editorconfig in Documentation/, Index.rst in every directory
2. •4-space indentation, no tabs, max 80 chars
3. •Code blocks have :caption:, inline code uses proper roles (:php:, :file:)
4. •Screenshots exist with :alt: and :zoom: lightbox
5. •scripts/validate_docs.sh passes, render output has no warnings
6. •README and Documentation/ are synchronized

Reference Documentation

• •references/file-structure.md -- directory layout, naming conventions
• •references/guides-xml.md -- build configuration, interlink settings
• •references/coding-guidelines.md -- .editorconfig, indentation rules
• •references/rst-syntax.md -- headings, lists, tables, formatting
• •references/text-roles-inline-code.md -- :php:, :file:, :guilabel:, :ref:
• •references/code-structure-elements.md -- code blocks, confval, PHP domain
• •references/typo3-directives.md -- confval, versionadded, deprecated
• •references/content-directives.md -- accordion, tabs, card-grid
• •references/screenshots.md -- image requirements, figure directives
• •references/rendering.md -- Docker commands, live preview
• •references/intercept-deployment.md -- webhook, build triggers
• •references/architecture-decision-records.md -- ADR templates
• •references/documentation-coverage-analysis.md -- gap analysis
• •references/extraction-patterns.md -- automated extraction
• •references/typo3-extension-architecture.md -- file hierarchy
• •references/scripts-guide.md -- extraction and analysis scripts
• •references/asset-templates-guide.md -- templates, screenshot workflow

External Resources

• •TYPO3 Documentation Writing Guide
• •TYPO3 Documentation Rendering
• •TYPO3 Directive Reference

Contributing: https://github.com/netresearch/typo3-docs-skill