このドキュメントは、Dify開発者ドキュメントのコアメタデータを迅速に定義するのに役立ちます。これらのフィールドを正確に記入することは、ドキュメントの自動化された構造と並べ替えを実装するための鍵です。

​
クイックスタート

1

ドキュメントコンテンツの準備

ドキュメントコンテンツの作成を完了します。

2

AIでメタデータを生成

あなたのドキュメントとdimensionsシステムの説明の内容を、お好みの大規模言語モデルに提供し、適切なFrontmatterの生成を依頼します。

3

手動での調整

実際の状況と以下の詳細な説明に基づいて、生成されたメタデータに必要な調整と最適化を行います。

​
必須Frontmatterフィールド

各Markdownドキュメントの先頭に以下のYAML Frontmatterを追加してください：

---
# --- コアシステムメタデータ（構造と並べ替えに影響）---
dimensions:
  type:
    primary: <以下のオプションを参照>
    detail: <以下のオプションを参照>
  level: <以下のオプションを参照>
standard_title: '英語による説明的なタイトル、ファイル名生成に使用' # 例：'Getting Started Dify Plugin'
language: 'ja' # または 'en', 'zh'など（ISO 639-2コード）

# --- ページコンテンツメタデータ（オプションだが推奨）---
title: 'ドキュメントのH1タイトルまたはページタイトル'
description: 'ドキュメントコンテンツの簡潔なSEO説明'
# summary: 'より詳細な要約（オプション）'
# tags: ['キーワード']（オプション）
---

​
dimensionsフィールドの理解

conceptual

概念、理論（何/なぜ）
概念と基本理論の説明に焦点を当てる

implementation

開発プラクティス、コード（どのように）
実装手順とコード例の提供に焦点を当てる

operational

運用、デプロイメント（どのように実行する）
システム運用と保守に焦点を当てる

reference

API、設定リファレンス（正確な検索）
技術仕様とリファレンス情報の提供に焦点を当てる

​
その他の重要なフィールド

​
standard_title
string
required

英語を使用して、ドキュメントのコアコンテンツを明確に説明します。システムはこれを使用してファイル名の一部を生成します（例：Getting Started Dify Plugin）。

​
language
string
required

ISO 639-2の2文字言語コード（例：en、zh、ja）。

​
title
string

ページに表示されるドキュメントのメインタイトル、通常はローカライズされた言語で記述されます。

​
description
string

検索エンジンとプレビュー用の簡潔なSEO説明。

​
完全な例

---
dimensions:
  type:
    primary: conceptual
    detail: introduction
  level: beginner
standard_title: 'Getting Started Dify Plugin'
language: ja
title: 'Difyプラグイン開発へようこそ'
description: 'Difyプラグインの概念、機能、開発価値の紹介。プラグインタイプの簡単な説明と開発者ドキュメントの内容の概要を含みます。'
---

例の解釈： 最初の例は、初心者向けのDifyプラグインの概念に関する導入ドキュメントで、言語は日本語です。システムはメタデータに基づいて、ドキュメント構造内に自動的に正しく配置します。

​
ドキュメント自動化処理

tools/main_docs_bundle.pyを実行すると、ドキュメントはFrontmatterに基づいて以下の操作を自動的に完了します：

1

ファイル名の変更

システムはdimensionsとstandard_titleに基づいて標準化されたファイル名を自動的に生成します。

2

ナビゲーションの更新

ドキュメントはdocs.jsonナビゲーション設定に自動的に挿入されます。

3

インタラクティブコンポーネントの追加

貢献とフィードバックボタンなどのインタラクティブコンポーネントを自動的に更新します。

ローカル環境でドキュメントを開発する場合、ドキュメント設定が正しく反映されるようにこのスクリプトを実行することをお勧めします。

もっと詳しく知りたいですか？

Dimensionsシステムの設計哲学、並べ替えメカニズムの完全な詳細、または役割とガバナンスに興味がある場合は、Dimensionsシステムの詳細な説明ドキュメントをお読みください。

このページを編集する | 問題を報告する