mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-27 13:28:32 +07:00
124 lines
7.2 KiB
Plaintext
124 lines
7.2 KiB
Plaintext
---
|
||
dimensions:
|
||
type:
|
||
primary: reference
|
||
detail: core
|
||
level: beginner
|
||
standard_title: 'Doc Contribution Guide'
|
||
language: ja
|
||
title: '貢献ガイド'
|
||
summary: 'Dify開発者ドキュメントへの貢献方法を学び、既存ドキュメントの更新や新規ドキュメントの作成ステップとガイドラインを理解し、高品質なドキュメントリソースを共同で構築しましょう。'
|
||
---
|
||
|
||
Difyドキュメントの共同構築へようこそ！このガイドでは、Dify開発者ドキュメントへの貢献プロセスと仕様を説明し、コミュニティメンバーがドキュメントの品質を共同で向上させることを奨励・支援します。
|
||
|
||
## 既存ドキュメントの更新
|
||
|
||
<Tabs>
|
||
<Tab title="推奨方法">
|
||
修正したいドキュメントページの下部にある <Icon icon="pen-to-square" /> **このページを編集する** ボタンをクリックしてください。これにより、GitHubの対応するソースファイルに直接リンクします。
|
||
|
||
</Tab>
|
||
<Tab title="URL経由での特定">
|
||
DifyドキュメントのURLは、GitHubリポジトリ内の相対パスと明確に対応しています。構造に慣れた貢献者は以下を参考にできます：
|
||
|
||
| URL (例) | GitHubリポジトリの相対パス (例) |
|
||
| :--- | :--- |
|
||
| `https://docs.dify.ai/plugin-dev-ja/0111-getting-started-dify-plugin` | `plugin-dev-ja/0111-getting-started-dify-plugin.mdx` |
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
---
|
||
|
||
<Note>
|
||
編集する際は、コンテンツの正確性と明確さに焦点を当ててください。ファイルの先頭にあるFrontmatterメタデータや、末尾の特定のスクリプトや含まれるコンテンツは、通常、コア貢献者または自動化プロセスによって管理・維持されています。
|
||
</Note>
|
||
|
||
<Check>
|
||
ドキュメントに問題を見つけた場合は、ページにある **問題を報告する** ボタンを使用して報告することもできます。正確な問題報告は、コミュニティとプロジェクトの両方にとって重要な貢献です。
|
||
</Check>
|
||
|
||
## 新規ドキュメントの作成
|
||
|
||
<Steps>
|
||
<Step title="ファイルの作成">
|
||
適切な言語ディレクトリ（例：`plugin-dev-ja`）に新しい`.mdx`ファイルを作成します。
|
||
|
||
最初はファイル名を自由に決めることができます（例：`my-new-feature.mdx`）が、ファイル名は十分に説明的である必要があります。システムは後で、ドキュメントのメタデータに基づいて標準化されたファイル名を生成します。
|
||
</Step>
|
||
|
||
<Step title="コンテンツの作成">
|
||
<Accordion title="Markdown構文ガイドライン">
|
||
標準の **Markdown** 構文に従ってください。MDXファイルでは、HTML形式の `<!-- comment -->` ではなく、JSX形式のコメント：`{/* これはMDXコメントです */}` を使用してください。
|
||
</Accordion>
|
||
|
||
<Accordion title="Mintlifyコンポーネント">
|
||
Mintlifyが提供するコンポーネントを適切に使用して、コンテンツの構造と表示を最適化できます：
|
||
|
||
```jsx
|
||
<Note>
|
||
これは重要な注意事項です。
|
||
</Note>
|
||
|
||
<Warning>
|
||
これは警告メッセージです。
|
||
</Warning>
|
||
|
||
<Card title="関連リソース" icon="book">
|
||
詳細については、関連リソースを参照してください...
|
||
</Card>
|
||
```
|
||
|
||
その他のコンポーネントについては、[Mintlifyコンポーネントドキュメント](https://mintlify.com/docs)を参照してください。
|
||
</Accordion>
|
||
</Step>
|
||
|
||
<Step title="Frontmatter（メタデータ）の追加">
|
||
各ドキュメントにはFrontmatterメタデータを定義する必要があります：
|
||
|
||
* 正しく設定されたFrontmatterは、ドキュメントが正確にインデックス化され、適切に並べ替えられ、ドキュメントウェブサイト上で正しく表示・ナビゲートされるようにするための鍵です。
|
||
* **あなたの主な任務は、高品質で正確なドキュメントコンテンツを提供することです。**
|
||
* Difyの[ドキュメントFrontmatterメタデータガイド](/plugin-dev-ja/0412-doc-writing-dimensions-guide)に精通している場合は、提出時にFrontmatterを含めることを歓迎します。
|
||
* **Frontmatterの記入方法がわからない場合や、コンテンツ作成に集中したい場合でも問題ありません。** Frontmatterなし、または部分的なメタデータのみでPull Requestを提出できます。コミュニティやプロジェクトのコア貢献者が、その後の追加、レビュー、最適化を支援します。
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Check>
|
||
**あなたのコンテンツ貢献は非常に重要です。** 完全なFrontmatterを提供できなくても、あなたのPull Requestは歓迎されます。ドキュメントが最終的に標準化されたメタデータを持ち、正常に統合されるようにすることは、コミュニティとコアチームの協力的な取り組みです。
|
||
</Check>
|
||
|
||
## 貢献の提出
|
||
|
||
ドキュメントの編集や新規作成が完了したら、GitHubを通じてメインリポジトリにPull Requestを送信してください。コミュニティメンバーとプロジェクトのメンテナーがあなたの貢献をレビューします。
|
||
|
||
## よくある質問
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="プログラミングのバックグラウンドがなくてもドキュメントに貢献できますか？">
|
||
もちろんです！ドキュメントへの貢献にプログラミングスキルは必要ありません。Difyについて理解があれば、既存ドキュメントの明確さと正確さを向上させたり、よりユーザーフレンドリーな説明や例を追加したりすることができます。
|
||
</Accordion>
|
||
|
||
<Accordion title="私の貢献が受け入れられるためにはどうすればよいですか？">
|
||
コンテンツが明確で正確であり、フォーマットガイドラインに従っていることを確認してください。提出前にスペルと文法をチェックしてください。不確かな場合は、提出前にコミュニティでアイデアを議論することができます。
|
||
</Accordion>
|
||
|
||
<Accordion title="日本語以外の言語で貢献できますか？">
|
||
はい！多言語ドキュメントの貢献を歓迎します。ファイルが対応する言語ディレクトリに配置され、Frontmatterで言語コードが正しくラベル付けされていることを確認してください。
|
||
</Accordion>
|
||
</AccordionGroup>
|
||
|
||
---
|
||
|
||
Difyコミュニティとドキュメントへの貢献に感謝します！
|
||
|
||
{/*
|
||
Contributing Section
|
||
DO NOT edit this section!
|
||
It will be automatically generated by the script.
|
||
*/}
|
||
|
||
---
|
||
|
||
[このページを編集する](https://github.com/langgenius/dify-docs/edit/main/plugin-dev-ja/0411-doc-contribution-guide.mdx) | [問題を報告する](https://github.com/langgenius/dify-docs/issues/new?template=docs.yml)
|
||
|