# 指南 (/zh/guides)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 1616 · updated: 2026-07-30 -->

本节中的指南提供了关于如何创建文档的建议，帮助你的用户取得成功。无论你是从零开始，还是在改进现有文档，这些指南都能帮助你规划、撰写和维护文档。

最重要的是，要始终考虑用户的需求和目标。围绕能帮助他们使用你的产品并尽快回到自己任务的内容进行文档编写。

<div id="topics">
  ## 主题 [#主题]
</div>

<div id="ai-tools">
  ### AI 工具 [#ai-工具]
</div>

使用 AI 驱动的工具加速你的文档工作流程。

* [构建应用内 AI 助手](/zh/guides/assistant-embed)：教程，讲解如何在 React 应用中添加 AI 聊天机器人，帮助用户从你的文档中找到答案。
* [配置自动合并](/zh/guides/configure-automerge)：将 Mintlify GitHub 应用添加到规则集的绕过列表中，以为自动化启用自动合并。
* [使用自动化](/zh/guides/use-automations)：选择合适的自动化触发器、撰写有效的指令，并从自动化的内容维护中获得一致的结果。
* [Claude Code](/zh/guides/claude-code)、[Codex](/zh/guides/codex)、[Cursor](/zh/guides/cursor)、[Devin Desktop](/zh/guides/devin-desktop)：使用 AI 编程助手维护文档的指南。
* [GEO](/zh/guides/geo)：为 AI 搜索和问答引擎优化文档的最佳实践。

<div id="api-documentation">
  ### API 文档 [#api-文档]
</div>

创建 API 文档，使用户能够测试并学习如何使用你的 API，并且便于维护。

* [从 MDX 迁移到 OAS](/zh/guides/migrating-from-mdx): 将你的 API 文档从单独的 MDX 页面迁移到基于 OpenAPI 规范自动生成的页面。

<div id="best-practices">
  ### 最佳实践 [#最佳实践]
</div>

让你的文档做到行业一流。

* [Accessibility](/zh/guides/accessibility)：让尽可能多的用户都能无障碍使用你的文档。
* [Content types](/zh/guides/content-types)：为教程、操作指南、参考文档和解释性文档选择合适的形式。
* [Content templates](/zh/guides/content-templates)：为每种内容类型复用并修改相应的模板。
* [Custom page layouts](/zh/guides/custom-layouts)：使用页面模式和组件构建落地页和其他自定义布局。
* [Improve your docs](/zh/guides/improving-docs)：利用数据和反馈持续改进你的文档。
* [Internationalization](/zh/guides/internationalization)：配置多语言文档，以触达全球用户。
* [Linking](/zh/guides/linking)：创建内部链接、引用 API 端点，并在整个文档中维护链接的完整性。
* [Maintenance](/zh/guides/maintenance)：保持文档准确且始终是最新的。
* [Media](/zh/guides/media)：在控制维护成本的同时，高效地添加图片、视频和其他媒体。
* [Organize navigation](/zh/guides/navigation)：设计符合用户习惯的信息架构。
* [SEO](/zh/guides/seo)：为搜索引擎优化你的文档。
* [Style and tone](/zh/guides/style-and-tone)：保持一致的文风和语气进行写作。
* [Understand your audience](/zh/guides/understand-your-audience)：研究并满足用户的需求和目标。

<div id="git-workflows">
  ### Git 工作流 [#git-工作流]
</div>

了解 Git，以便在 Mintlify 中以及采用文档即代码 (docs-as-code) 的方法时发挥最大效用。

* [Git 基本概念](/zh/guides/git-concepts)：学习用于文档工作的 Git 基础知识。
* [Branch](/zh/guides/branches)：使用 branch 管理文档更改。

<div id="use-cases">
  ### 使用场景 [#使用场景]
</div>

了解 Mintlify 如何满足不同的使用需求，并找到适合你的解决方案。

* [创建开发者文档](/zh/guides/developer-documentation)：通过能够解答用户疑问、让他们迅速回到主要任务的开发者文档，帮助用户最大化发挥你的产品或 API 的价值。
* [创建知识库](/zh/guides/knowledge-base)：搭建内部知识库，为团队整合信息、提升搜索效率，并减轻维护负担。
* [创建帮助中心](/zh/guides/help-center)：搭建自助式帮助中心，让用户能够自主找到答案，减少工单数量，并提升客户满意度。
* [创建自定义前端](/zh/guides/custom-frontend)：使用 Mintlify 的 Astro 集成，通过完全自定义的前端来渲染你的文档。

<div id="where-to-start">
  ## 从哪里开始 [#从哪里开始]
</div>

<CardGroup cols="2">
  <Card title="文档新手？" icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M8 10.1667L12.1232 6.04344C13.2481 4.91858 13.8105 4.35614 14.4312 3.90314C15.7047 2.9737 17.1818 2.36187 18.7395 2.11858C19.4988 2 20.2942 2 21.885 2C21.9681 2 22 2.03812 22 2.11504C22 3.70584 22 4.50125 21.8814 5.26046C21.6381 6.81818 21.0263 8.29527 20.0969 9.56878C19.6439 10.1895 19.0814 10.7519 17.9566 11.8768L13.8333 16&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M10.341 8.09838C8.63808 8.09838 6.49778 7.73765 4.9043 8.39769C3.73671 8.88132 2.87754 10.0012 2 10.8787L5.30597 12.2955C6.18208 12.671 5.64651 13.7766 5.50147 14.5018C5.33985 15.3099 5.34886 15.3397 5.93158 15.9224L8.07758 18.0684C8.6603 18.6511 8.69008 18.6602 9.49816 18.4985C10.2234 18.3535 11.329 17.8179 11.7044 18.694L13.1213 22C13.9988 21.1225 15.1187 20.2633 15.6023 19.0957C16.2624 17.5022 15.9016 15.3619 15.9016 13.659&#x22; stroke=&#x22;currentColor&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M12 20L11 21&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M4 12L3 13&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M15 4.07996C16.2 4.25996 17.46 4.73996 18.1614 5.45996C19.0576 6.25211 19.68 7.31996 19.92 8.99996&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;square&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M17.94 6.06006L16.5 7.50006&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" href="/zh/guides/content-types">
    了解内容类型，掌握如何设计文档结构。
  </Card>

  <Card title="要改进现有文档？" icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M7 15.2461L9.87381 11.5319C10.1242 11.2082 10.2495 11.0464 10.3862 10.9354C10.7975 10.6017 11.3471 10.5135 11.8368 10.7026C11.9997 10.7654 12.1664 10.8804 12.5 11.1103C12.8336 11.3402 13.0003 11.4552 13.1632 11.518C13.6529 11.7071 14.2025 11.6189 14.6138 11.2852C14.7505 11.1742 14.8757 11.0124 15.1262 10.6887L15.9061 9.68068C16.8833 8.41772 17.3719 7.78624 18.0414 7.7479C18.7109 7.70956 19.264 8.28139 20.3701 9.42505L21 10.0764&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M21 21H10C6.70017 21 5.05025 21 4.02513 19.9749C3 18.9497 3 17.2998 3 14V3&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" href="/zh/guides/improving-docs">
    了解如何使用指标和反馈来优化文档。
  </Card>

  <Card title="与团队协作？" icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M7 20C8.10457 20 9 19.1046 9 18C9 16.8954 8.10457 16 7 16C5.89543 16 5 16.8954 5 18C5 19.1046 5.89543 20 7 20Z&#x22; stroke=&#x22;currentColor&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M7 8C8.10457 8 9 7.10457 9 6C9 4.89543 8.10457 4 7 4C5.89543 4 5 4.89543 5 6C5 7.10457 5.89543 8 7 8Z&#x22; stroke=&#x22;currentColor&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M17 14C18.1046 14 19 13.1046 19 12C19 10.8954 18.1046 10 17 10C15.8954 10 15 10.8954 15 12C15 13.1046 15.8954 14 17 14Z&#x22; stroke=&#x22;currentColor&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M7.02116 8.2793V15.4073M14.4113 12.0047L10.0193 12.0048C8.92158 12.0048 6.86182 11.1254 7.01818 8.78001&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" href="/zh/guides/git-concepts">
    学习适用于团队协作文档的 Git 工作流。
  </Card>
</CardGroup>