如何针对AI代码助手优化技术文档：面向LLM的GEO实践

如今，GitHub Copilot, Cursor 等 AI 代码助手已成为程序员的标配。这属于 GEO（生成式引擎优化）在技术研发领域的垂直应用。本文将分享如何优化技术文档，让 AI 代码助手更懂你的开源项目或商业 SDK。

1. 为什么传统 API 文档对 AI 不够友好？

传统文档只有零散的类属性定义，缺乏上下文，AI 很难理解 API 之间的配合使用和最佳实践。AI 倾向于学习文档中大段、可运行的代码示例。

2. 文档优化实战策略

2.1 编写完整、可运行的代码示例

避免使用含有伪代码注释的示例。确保文档中的 Example 代码是即插即用、可以直接运行的完整片段。

2.2 明确标注废弃 (Deprecated) 接口与版本差异

使用醒目的警告框（如 Markdown Warning Alerts）标注接口变更，帮助联网检索的 AI 助手识别最新 API，避免推荐过时代码。

2.3 规范声明代码块语言标识符

准确声明代码块对应的编程语言，帮助大模型的分词器和解析器更精准地切分和学习代码结构。