指南

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

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

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

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

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

• 从 MDX 迁移到 OAS: 将你的 API 文档从单独的 MDX 页面迁移到基于 OpenAPI 规范自动生成的页面。

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

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

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

• Git 基本概念：学习用于文档工作的 Git 基础知识。
• Branch：使用 branch 管理文档更改。

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

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