mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-29 13:48:35 +07:00
89 lines
4.5 KiB
Plaintext
89 lines
4.5 KiB
Plaintext
---
|
||
title: ドキュメントへの貢献
|
||
---
|
||
|
||
|
||
Dify のヘルプドキュメントは、[オープンソースプロジェクト](https://github.com/langgenius/dify-docs)として運営されています。どのような形式の貢献も歓迎します。ドキュメントに問題を見つけた場合や、自分で内容を追加したい場合には、GitHub 上で issue を提出するか、もしくは直接 pull request を作成してください。我々は迅速に対応いたします。
|
||
|
||
## 貢献の方法
|
||
|
||
ドキュメントの問題は次の2つのカテゴリーに分けられます：
|
||
|
||
* コンテンツ修正
|
||
* コンテンツ追加
|
||
* ベストプラクティス
|
||
|
||
### コンテンツの誤り
|
||
|
||
ドキュメントを読んでいる際に内容の誤りを見つけたり、一部を修正したい場合は、文書ページの右側にある目次内の **“GitHub に編集”** ボタンをクリックしてください。これにより、GitHub のオンラインエディターを使用してファイルを修正できます。その後、修正内容を簡潔に説明した pull request を作成してください。タイトルは `Fix: Update xxx` の形式を使用してください。リクエストを受け取った後、レビューを行い、問題がなければ修正をマージします。
|
||
|
||
|
||
|
||
もちろん、[Issues ページ](https://github.com/langgenius/dify-docs/issues)にドキュメントのリンクを貼り付け、修正が必要な内容を簡単に説明していただくことも可能です。フィードバックを受け取った後、迅速に対応いたします。
|
||
|
||
### コンテンツの欠落
|
||
|
||
新しいドキュメントをコードリポジトリに追加したい場合は、以下の手順に従ってください：
|
||
|
||
1. リポジトリをフォークする
|
||
|
||
リポジトリを GitHub アカウントにフォークし、リポジトリをローカルにクローンします:
|
||
|
||
```bash
|
||
git clone https://github.com/<your-github-account>/dify-docs.git
|
||
```
|
||
|
||
<Note>
|
||
注: GitHub のオンラインコードエディターを使用して、新しい md ファイルを適切なディレクトリに直接送信することもできます。
|
||
</Note>
|
||
2. 関連するドキュメントディレクトリを見つけてファイルを追加する
|
||
|
||
たとえば、サードパーティツールの使用方法に関するドキュメントを追加したい場合は、`/guides/tools/tool-configuration/` ディレクトリに新しい md ファイルを追加してください。
|
||
|
||
3. pull request を提出する
|
||
|
||
pull request を提供する時、`Docs: add xxx` のタイトルで説明欄に書いて、文章内容を簡単に記載してください。request を受け取った後、review を行い、問題がなければ merge します。
|
||
|
||
## ベストプラクティス
|
||
|
||
Difyで構築した革新的なアプリケーション事例の共有を大歓迎します！コミュニティメンバーが皆様の実践経験を理解・再現しやすくするため、以下の構成でのコンテンツ作成をお勧めします：
|
||
|
||
```text
|
||
1. プロジェクト概要
|
||
- アプリケーションの活用シーンと解決課題
|
||
- コア機能と特徴
|
||
- デモンストレーションと成果
|
||
|
||
2. システム設計・処理フロー
|
||
|
||
3. 事前準備（必要な場合）
|
||
- 必要リソース一覧
|
||
- ツールと依存関係
|
||
|
||
4. Dify実装手順（参考）
|
||
- アプリケーション作成と基本設定
|
||
- ワークフロー構築の詳細
|
||
- 主要ノード設定解説
|
||
|
||
5. FAQ
|
||
```
|
||
|
||
>説明用のスクリーンショットを追加される場合は、オンライン画像ホスティングサービスのリンクをご利用ください。
|
||
|
||
皆様の貴重なナレッジシェアが、Difyコミュニティの発展を支えます！
|
||
|
||
## ヘルプを受ける
|
||
|
||
貢献の過程で困難に直面したり、疑問がある場合は、関連する GitHub の issue に質問を投稿するか、[Discord](https://discord.com/invite/8Tpq4AcN9c) に参加して迅速にコミュニケーションを取ることができます。
|
||
|
||
{/*
|
||
Contributing Section
|
||
DO NOT edit this section!
|
||
It will be automatically generated by the script.
|
||
*/}
|
||
|
||
---
|
||
|
||
[このページを編集する](https://github.com/langgenius/dify-docs/edit/main/ja-jp/community/docs-contribution.mdx) | [問題を報告する](https://github.com/langgenius/dify-docs/issues/new?template=docs.yml)
|
||
|