> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/guides.md).

# 指南

探索在 GitBook 中创建和组织文档的指南

GitBook 的编辑器让创建和自定义文档变得轻而易举，无论你是从零开始还是在现有空间中工作。

#### 探索

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-pen-ruler">:pen-ruler:</i></h4></td><td><h4>如何使用 GitBook 的编辑器</h4></td><td>创建页面、添加内容块并发布文档</td><td><a href="https://gitbook.com/docs/guides/editing-and-publishing-documentation/how-to-use-gitbooks-editor.md">How to use GitBook’s editor</a></td></tr><tr><td><h4><i class="fa-file-import">:file-import:</i></h4></td><td><h4>从 CSV 文件导入内容</h4></td><td>从 Zendesk 或其他 CSV 导出文件中导入文档</td><td><a href="https://gitbook.com/docs/guides/editing-and-publishing-documentation/import-zendesk-csv-to-gitbook.md">How to import docs from a CSV</a></td></tr><tr><td><h4><i class="fa-circle-play">:circle-play:</i></h4></td><td><h4>嵌入可播放的视频</h4></td><td>直接将视频内容添加到你的文档中</td><td><a href="https://gitbook.com/docs/guides/editing-and-publishing-documentation/upload-and-embed-a-playable-video-into-your-gitbook-docs.md">How to embed videos in docs</a></td></tr><tr><td><h4><i class="fa-magnifying-glass">:magnifying-glass:</i></h4></td><td><h4>使用 Git Sync 批量修改</h4></td><td>通过代码编辑器更新文档中重复出现的内容</td><td><a href="https://gitbook.com/docs/guides/editing-and-publishing-documentation/find-and-replace-or-make-batch-changes-across-your-gitbook-docs-with-git-sync.md">How to find and replace content</a></td></tr></tbody></table>

#### 快速指南

<details>

<summary>我该如何组织我的文档结构？</summary>

围绕读者需要完成的任务来组织页面和分组。

本指南涵盖页面层级规划、分组创建以及导航优化。

<button type="button" class="button secondary" data-action="ask" data-query="How do I structure GitBook documentation around reader tasks? Show me how to plan page hierarchy, create groups, organize pages, and refine navigation. Include links to the relevant docs pages." data-icon="gitbook-assistant">打开指南</button>

</details>

<details>

<summary>我该如何在页面之间复用内容？</summary>

可复用内容能让文档中的共享文本保持一致。

本指南涵盖创建可复用区块、将其插入页面以及更新共享内容。

<button type="button" class="button secondary" data-action="ask" data-query="How do I reuse content across GitBook pages? Show me how to create reusable blocks, insert them into pages, and update shared content. Include links to the relevant docs pages." data-icon="gitbook-assistant">打开指南</button>

</details>

<details>

<summary>我该如何使用变量管理重复值？</summary>

变量让你只需定义一次值，然后在内容中重复使用。

本指南涵盖创建变量、在页面中引用变量以及维护共享值。

<button type="button" class="button secondary" data-action="ask" data-query="How do I manage repeated values with GitBook variables? Show me how to create variables, reference them in pages, and maintain shared values. Include links to the relevant docs pages." data-icon="gitbook-assistant">打开指南</button>

</details>

<details>

<summary>我该如何创建文档风格指南？</summary>

风格指南可确保你的文档在各个贡献者以及 AI 辅助修改之间保持一致。

本指南涵盖制定写作规则、添加术语指导以及维护指南。

如需逐步说明，请参阅 [构建你的风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/build-your-style-guide.md).

<button type="button" class="button secondary" data-action="ask" data-query="How do I create a GitBook documentation style guide? Show me how to define writing rules, add terminology guidance, and maintain the guide. Include links to the relevant docs pages." data-icon="gitbook-assistant">打开指南</button>

</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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/guides.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
