AI 文档平台
构建一个完整的文档平台，从代码库自动生成文档，与代码变更保持同步，支持交互式示例、版本控制，并使用 AI 回答开发者关于文档化 API 的问题。
ragdocumentationcode-analysisdeveloper-experience
目标
- 扫描代码库并从注释和类型定义自动生成文档
- 创建带导航和版本控制的可搜索文档站点
- 构建使用文档作为上下文回答问题的 AI 问答聊天机器人
- 检测代码变更并标记过期的文档部分
- 支持可在浏览器中运行的交互式代码示例
提示
- 使用 JSDoc/TSDoc 注释和类型定义作为主要文档来源
- 为问答聊天机器人实现 RAG（检索增强生成）
- 使用文件监听或 Git Hooks 检测文档何时需要更新