跳转到主要内容
本节中的指南提供了关于如何创建文档的建议，帮助你的用户取得成功。无论你是从零开始，还是在改进现有文档，这些指南都能帮助你规划、撰写和维护文档。 最重要的是，要始终考虑用户的需求和目标。围绕能帮助他们使用你的产品并尽快回到自己任务的内容进行文档编写。

​
主题

​
AI 工具

使用 AI 驱动的工具加速你的文档工作流程。
  • 自动化文档更新：教程，讲解如何使用 agent 设置文档的自动更新。
  • 构建应用内 AI 助手：教程，讲解如何在 React 应用中添加 AI 聊天机器人，帮助用户从你的文档中找到答案。
  • Claude Code、Cursor、Windsurf：使用 AI 编程助手维护文档的指南。
  • GEO：为 AI 搜索和问答引擎优化文档的最佳实践。

​
API 文档

创建 API 文档，使用户能够测试并学习如何使用你的 API，并且便于维护。
  • 从 MDX 迁移到 OAS: 将你的 API 文档从单独的 MDX 页面迁移到基于 OpenAPI 规范自动生成的页面。

​
最佳实践

让你的文档做到行业一流。
  • Accessibility：让尽可能多的用户都能无障碍使用你的文档。
  • Content types：为教程、操作指南、参考文档和解释性文档选择合适的形式。
  • Improve your docs：利用数据和反馈持续改进你的文档。
  • Maintenance：保持文档准确且始终是最新的。
  • Media：在控制维护成本的同时，高效地添加图片、视频和其他媒体。
  • Organize navigation：设计符合用户习惯的信息架构。
  • SEO：为搜索引擎优化你的文档。
  • Style and tone：保持一致的文风和语气进行写作。
  • Understand your audience：研究并满足用户的需求和目标。

​
Git 工作流

了解 Git，以便在 Mintlify 中以及采用文档即代码（docs-as-code）的方法时发挥最大效用。
  • Git 基本概念：学习用于文档工作的 Git 基础知识。
  • Branch：使用 branch 管理文档更改。

​
使用场景

了解 Mintlify 如何满足不同的使用需求，并找到适合你的解决方案。
  • 创建知识库：搭建内部知识库，为团队整合信息、提升搜索效率，并减轻维护负担。

​
从哪里开始

文档新手？

了解内容类型，掌握如何设计文档结构。

要改进现有文档？

了解如何使用指标和反馈来优化文档。

要配置 AI 功能？

使用 agent 自动化更新文档。

与团队协作？

学习适用于团队协作文档的 Git 工作流。