生成引擎优化快速上手
初始设置
- 在 docs.json配置中确保文档已开启索引
- 审查现有页面是否缺少描述和标题
内容改进
- 在合适的页面添加对比表
- 审查各级标题以确保它们能回答常见问题
- 加强相关主题之间的内部链接
- 使用 AI 工具测试并验证准确性
生成引擎优化最佳实践
- 围绕用户需求,而非仅做关键词匹配
- 结构化、可快速扫读的信息
- 对问题作出直接回答
为清晰而格式化
- 不要跳过标题层级(H1 → H2 → H3)
- 使用明确的对象名称,避免用“it”或“this”
- 为代码块标注所用编程语言
- 为图片提供具有描述性的替代文本(alt 文本)
- 链接相关概念,帮助 AI 理解其关联
直接回答问题
- 各小节以核心结论开头
- 使用与常见搜索意图相匹配的描述性标题
- 将复杂主题拆解为编号步骤
Mintlify 配置
添加具描述性的页面元数据
配置全局索引设置
docs.json:
语言模型索引文件
测试你的文档
- “如何使用此 API 配置认证?”
- “请按步骤带我完成安装流程”
- 正确的代码示例
- 准确的分步指引