mcpField
T
typo3-docs

typo3-docs

github.com/dirnbauer开发3376 次安装13 周前更新
代码仓库

关于 typo3-docs

面向 TYPO3 扩展文档编写与维护的技能，遵循 docs.typo3.org 标准，提供从内容提取、格式规范到验证和渲染的工作流。适用于维护 TYPO3 扩展及其文档的开发者。

主要功能

  1. 01提取和分析文档覆盖情况
  2. 02按 TYPO3 指令组织内容
  3. 03RST 文件与目录规范
  4. 04校验并渲染文档
  5. 05核对示例代码与扩展源码

适用场景

  1. 01识别扩展文档缺失内容
  2. 02为配置选项和 PHP API 编写说明
  3. 03验证发布前的 RST 文档
  4. 04渲染文档并检查输出

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/dirnbauer/webconsulting-skills --skill typo3-docs

安装后在 Claude Code 中输入/typo3-docs确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

checkpoints.yaml
assets/
AGENTS.md
evals/
evals.json
references/
architecture-decision-records.md
asset-templates-guide.md
code-structure-elements.md
coding-guidelines.md
content-directives.md
documentation-coverage-analysis.md
extraction-patterns.md
file-structure.md
guides-xml.md
intercept-deployment.md
rendering.md
rst-syntax.md
screenshots.md
scripts-guide.md
text-roles-inline-code.md
typo3-directives.md
typo3-extension-architecture.md
scripts/
add-agents-md.sh
analyze-docs.sh
check-adr-coverage.sh
check-changelog-version-coverage.sh
check-guides-xml-version-sync.sh
check-required-doc-sections.sh
check-rst-substitutions-used.sh
check-unreleased-versions.sh
check-untranslated-fluid-strings.sh
check-version-match.sh

详细介绍

TYPO3 文档技能

按照 docs.typo3.org 官方标准创建和维护 TYPO3 扩展文档。

核心工作流

  1. 先运行提取脚本，找出文档缺口： 
    scripts/extract-all.sh /path/to/extension
scripts/analyze-docs.sh /path/to/extension
  2. 根据任务查阅相应的参考文件
  3. 使用 TYPO3 专用指令，而不是纯文本
  4. 验证：scripts/validate_docs.sh /path/to/extension
  5. 渲染：scripts/render_docs.sh /path/to/extension

重要：用户要求“显示文档”时，应渲染并显示 HTML 输出，而不是原始 RST。

元素选择指南

内容类型指令
完整代码literalinclude（优先于 code-block）
简短代码片段使用带 :caption: 的 code-block
配置选项使用带 :name:、:type:、:default: 的 confval
PHP APIphp:method::——对于可空类型或联合类型，使用 :returntype:
提示信息note、tip、warning、important
功能网格在页脚中使用带 stretched-link 的 card-grid
替代方案tabs（同步）
截图使用带 :zoom: lightbox :class: with-border with-shadow 的 figure

重要规则

  • UTF-8、4 个空格缩进、每行 80 个字符、LF
  • 文件名使用 CamelCase，标题使用句首字母大写
  • 每个标题前都要有永久链接锚点（.. _label:）
  • 每个子目录都要有 Index.rst
  • 截图使用 PNG，并带有 :alt: 和 :zoom: lightbox
  • 在 Documentation/ 中添加 .editorconfig
  • 后端模块、配置和工作流必须提供截图
  • 每个 RST 文件最多 250 行——使用 toctree 拆分
  • 不要使用 mailto:——改用 GitHub Issues/Discussions
  • PHP 域：不要在 php:method:: 中使用 ?Type/Type|null；请使用 :returntype:

代码示例验证

将代码示例与扩展源代码交叉核对： 在 Classes/ 中搜索方法名，将 CLI 参数与 configure() 进行比较， 验证 API 签名是否匹配。参见 references/extraction-patterns.md。

提交前检查清单

  1. Documentation/ 中有 .editorconfig，且每个目录中都有 Index.rst
  2. 使用 4 个空格缩进，不使用制表符，每行最多 80 个字符
  3. 代码块带有 :caption:，行内代码使用正确的角色
  4. 截图已添加，并带有 :alt: 和 :zoom: lightbox
  5. scripts/validate_docs.sh 验证通过，渲染时没有警告
  6. README 和 Documentation/ 内容保持同步

参考资料

  • references/file-structure.md -- 目录布局、命名约定
  • references/guides-xml.md -- 构建配置、互链设置
  • references/coding-guidelines.md -- .editorconfig、缩进规则
  • references/rst-syntax.md -- 标题、列表标点、文档审查常见问题
  • references/text-roles-inline-code.md -- :php:、:file:、:guilabel:、:ref:
  • references/code-structure-elements.md -- 代码块、confval、PHP 域
  • references/typo3-directives.md -- confval、versionadded、deprecated
  • references/content-directives.md -- accordion、tabs、card-grid
  • references/screenshots.md -- 图片要求、figure 指令
  • references/rendering.md -- Docker 命令、实时预览
  • references/intercept-deployment.md -- webhook、构建触发器
  • references/asset-templates-guide.md -- 模板、截图工作流
  • references/architecture-decision-records.md -- ADR 模式
  • references/documentation-coverage-analysis.md -- 覆盖率评分
  • references/scripts-guide.md -- 脚本选项
  • references/typo3-extension-architecture.md -- 扩展布局

致谢与署名

本技能基于 Netresearch DTT GmbH 的杰出工作。

原始代码库：https://github.com/netresearch/typo3-docs-skill

版权所有 (c) Netresearch DTT GmbH — 方法论与最佳实践（MIT / CC-BY-SA-4.0）

特别感谢 Netresearch DTT GmbH 为 TYPO3 社区慷慨贡献开源成果，助力塑造了这一技能集。 由 webconsulting.at 改编，用于此技能集

评论

支持 Markdown