typo3-docs

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

重要：「ドキュメントを表示して」とユーザーから依頼された場合は、生の RST ではなく、HTML 出力をレンダリングして表示してください。

要素の選択ガイド

コンテンツの種類	ディレクティブ
完全なコード	literalinclude（code-block より優先）
短いコードスニペット	:caption: を指定した code-block
設定オプション	:name:、:type:、:default: を指定した confval
PHP API	php:method:: — nullable 型／ユニオン型には :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/ 内でメソッド名を grep し、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

Copyright (c) Netresearch DTT GmbH — 方法論とベストプラクティス（MIT / CC-BY-SA-4.0）

このスキルコレクションの形成に貢献した、TYPO3 コミュニティへの寛大なオープンソース貢献について、Netresearch DTT GmbH に心より感謝します。 このスキルコレクション向けに webconsulting.at が適合