> For the complete documentation index, see [llms.txt](https://docs.cherryai.com.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cherryai.com.cn/docs/jp/contribution/docs.md).

# ドキュメントに貢献

ドキュメントへの貢献には、誤ったパスの修正、新機能チュートリアルの追加、スクリーンショットや例の改善、目次や翻訳の調整が含まれます。目的は「より多く書く」ことではなく、読者がページの手順に従って作業を完了できるようにすることです。

<figure><img src="/files/f61a6f41218acf62d8624204577a32b6f6297daa" alt="从明确文档问题、完成小范围修改到预览和提交评审的贡献流程图"><figcaption><p>ドキュメントの貢献も範囲を絞って行い、プレビューで確認してから Change Request を提出します。</p></figcaption></figure>

## 提出方法を選択する

* すでに GitBook の編集権限がある場合：該当する言語スペースで Change Request を作成する；
* 編集権限がない場合：Cherry Studio で【設定】→【私たちについて】→【フィードバック】を開き、ページのURL、問題点、提案内容を記載する；
* ドキュメントの問題がコード変更に関連する場合：コード PR でドキュメント項目にチェックを入れ、対応する Change Request を添付するか、更新不要である旨を記載する。

## GitBook の修正フロー

{% stepper %}
{% step %}

### 1. Change Request を作成する

正しい言語スペースに入り、下書きを作成し、公開済みコンテンツを直接編集しない。タイトルには関係するモジュールと目的を明確に書く。
{% endstep %}

{% step %}

### 2. まず現在の製品を確認する

現在の Cherry Studio 画面を使って、入口、ボタン、既定値、期待される結果を照合する。旧ページの構成が現在の製品と一致しない場合は、単にいくつかの用語を置き換えるのではなく、目次を組み直すべきです。
{% endstep %}

{% step %}

### 3. ユーザータスクに沿ってページを書く

冒頭で何ができるかを説明し、その後に正確なパス、番号付き手順、期待される結果、設定の説明、実例、よくある問題を示します。設定チュートリアルでは、まずユーザーに【作業】で Agent の支援を受けるよう促し、その後【設定】での手動パスを提示できます。
{% endstep %}

{% step %}

### 4. GitBook のネイティブコンテンツブロックを使用する

ヒントには Callout、連続操作には Stepper、よくある質問には折りたたみブロック、関連ページには Cards を使います。 `{% hint %}`、HTML タグや Markdown 記号を普通の文字としてページに残さないでください。
{% endstep %}

{% step %}

### 5. 実際のスクリーンショットを追加する

スクリーンショットは現在の製品画面から取得し、簡体字中国語、ライトテーマ、統一されたサイズを使用します。読者がクリックまたは確認する必要がある位置だけを注釈し、API Key、メールアドレス、ローカルパス、ユーザーデータは隠します。
{% endstep %}

{% step %}

### 6. プレビューしてレビューを提出する

各ページでタイトル、ナビゲーション、リンク、画像、Callout、Stepper、表、折りたたみブロックを確認します。下書きに不要なページ変更がないことを確認してからレビューを提出し、メンテナーがマージします。
{% endstep %}
{% endstepper %}

## ページ執筆要件

| 内容        | 要件                                       |
| --------- | ---------------------------------------- |
| 操作手順      | 【作業】→【スマートエージェントを追加】のように、画面に表示される名称を使用する |
| 用語        | 初出時に中国語の意味と役割を説明する                       |
| パラメータ     | 製品の既定値と推奨の開始値を区別し、役割とリスクを説明する            |
| 事例        | 具体的な役割、目標、入力、結果を使う                       |
| スクリーンショット | 実際の画面から取得し、代替テキストと番号付きの説明を付ける            |
| リンク       | 現在のページまたは公式ソースを指し、提出前に1つずつ開いて確認する        |

## スクリーンショットの注意事項

{% hint style="danger" %}
「完全に見える」ようにするために、成功結果を捏造しないでください。外部 API Key、課金サービス、または実アカウントが必要な機能については、設定入口と前提条件を示すことはできますが、接続成功、メッセージ送信、モデル出力を作り話にしてはいけません。
{% endhint %}

* アプリのコンテンツ領域を切り取り、特定の OS のウィンドウ装飾に依存しない；
* 画像中の番号は本文の説明と1対1で対応させる；
* 1枚の図は1つの主要タスクだけを担当させ、画面いっぱいの注釈は避ける；
* 同じページでは重要な手順だけを残し、普通のクリックごとにスクリーンショットを撮らない；
* アップロード後は Preview で、ファイル名やプレースホルダーテキストではなく、画像が実際に表示されていることを確認する。

## 読者による検証

執筆に参加していない人に、チュートリアルだけを見て一連の操作を完了してもらってください。どの段階で止まったか、どの用語が理解できなかったか、どの図が役に立たなかったかを記録し、その後で修正します。文書が文法チェックに通ることは、読者が手順どおりに完了できることと同義ではありません。

{% hint style="success" %}
1ページのチュートリアルにとって理想的な結果は、読者がいつ使うのか、どこから入るのか、各ステップで何が見えるのか、失敗したらまずどこを確認するのか、完了後にどう結果を確認するのかを理解できることです。
{% endhint %}

## セルフチェックリスト

* 古い入口、古い名称、または古い機能がない；
* 不安定なモデルランキング、価格、「最適な構成」を固定して書いていない；
* バージョン番号、検証日、内部実装パスで読みづらくなっていない；
* 画面名称はすべて【】で統一している；
* 本文が、生成レポートではなく製品編集者がユーザーに向けて書いたように読める；
* 各ステップに対応する入口を、現在の画面から見つけられる；
* 画像、リンク、GitBook のネイティブコンテンツブロックが Preview で正常にレンダリングされる。

<details>

<summary>公開済みページを直接編集してもいいですか？</summary>

だめです。Change Request を使って変更範囲とレビュー過程を残し、問題がないことを確認してから、権限のある人がマージします。

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cherryai.com.cn/docs/jp/contribution/docs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.