> 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/zhong-wen-fan-ti/contribution/docs.md).

# 貢獻文檔

文檔貢獻包括修正錯誤路徑、補充新功能教學、改善截圖同示例、調整目錄同翻譯。目標唔係「寫得更多」，而係令讀者可以跟住頁面步驟完成任務。

<figure><img src="/files/608da362fb1d44457c5c90962298d98ccc1fd8e8" alt="从明确文档问题、完成小范围修改到预览和提交评审的贡献流程图"><figcaption><p>文檔貢獻同樣要保持範圍聚焦，Preview 通過之後先提交 Change Request。</p></figcaption></figure>

## 選擇提交方式

* 已有 GitBook 編輯權限：喺對應語言空間建立 Change Request；
* 冇編輯權限：喺 Cherry Studio 打開【設定】→【關於我哋】→【回饋】，講明頁面地址、問題同建議內容；
* 文檔問題同程式碼變更相關：喺程式碼 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. Preview 並提交評審

逐頁檢查標題、導覽、連結、圖片、Callout、Stepper、表格同摺疊區塊。確認草稿冇無關頁面變更之後提交評審，由維護者合併。
{% endstep %}
{% endstepper %}

## 頁面寫作要求

| 內容   | 要求                      |
| ---- | ----------------------- |
| 操作路徑 | 使用界面可見名稱，例如【工作】→【添加智能體】 |
| 術語   | 首次出現時解釋中文含義同作用          |
| 參數   | 區分產品預設值同建議起點，說明作用同風險    |
| 案例   | 使用具體角色、目標、輸入同結果         |
| 截圖   | 嚟自真實界面，有替代文字同編號說明       |
| 連結   | 指向而家頁面或者官方來源，提交前逐一打開    |

## 截圖注意事項

{% hint style="danger" %}
唔好為咗「睇落完整」而偽造成功結果。需要外部 API Key、收費服務或者真實帳號嘅功能，可以展示設定入口同前置條件，但唔可以捏造連線成功、訊息送達或者模型輸出。
{% endhint %}

* 擷取應用內容區，唔好依賴某個系統嘅視窗裝飾；
* 圖片入面嘅編號同正文說明一一對應；
* 一張圖只負責一個主要任務，避免成版都係標註；
* 同一頁面保留關鍵步驟，唔好每次普通撳一下都截圖；
* 上傳之後喺 Preview 入面確認圖片實際有顯示，唔係只睇檔名或者佔位文字。

## 讀者驗收

請搵一位冇參與編寫嘅人，只睇教學完成一次操作。記錄佢喺邊一步停低、邊個名詞唔明、邊張圖冇幫助，然後再改。文檔通過語法檢查，唔等於讀者可以照住完成任務。

{% hint style="success" %}
一頁教學最理想嘅結果係：讀者知道幾時用、由邊度入、每一步會見到乜、失敗之後先檢查邊度，同埋完成之後點樣確認結果。
{% 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/zhong-wen-fan-ti/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.