关于 ShowDoc

ShowDoc 是一个在线文档管理系统，用于管理和分享项目文档，支持 API 文档、技术规范、产品说明、团队知识库等场景。

ShowDoc 新增了 AI 知识库助手功能，支持基于项目文档的智能问答。

功能说明

在项目文档较多的情况下，查找信息可能比较耗时。AI 知识库助手可以帮助你：

• 快速定位文档中的具体信息
• 理解文档中的复杂概念
• 整合分散在多个文档中的信息
• 辅助新人快速了解项目

工作原理

AI 知识库助手会将项目文档构建成知识库，基于文档内容回答你的问题。与关键词搜索不同，它能理解问题的语义，从知识库中找到相关内容并给出答案。

主要特性：

• 自动索引：文档保存后自动更新到知识库
• 语义理解：基于文档语义匹配，不只是关键词搜索
• 来源标注：答案会标注来源文档，可查看原文

示例：

• 传统搜索：输入"用户登录"，返回包含该关键词的页面列表，需要逐个查看
• AI 知识库助手：提问"用户登录的接口地址是什么？"，直接返回答案和文档链接

使用场景

1. 查找信息

可以提问：

• "这个项目的部署流程是什么？"
• "用户权限有哪几种？"
• "支付接口的参数格式是什么？"

2. 新人了解项目

新成员可以通过提问快速了解项目：

• "这个项目是做什么的？"
• "如何开始开发？"
• "常用的 API 接口有哪些？"

3. 理解概念

可以询问文档中的专业术语和概念：

• "什么是 OAuth2 认证流程？"
• "数据库分表是怎么实现的？"

4. 跨文档查询

当答案分散在多个文档时，可以整合查询：

• "用户从注册到发起订单的完整流程是什么？"

使用方法

项目管理员：开启功能

1. 进入项目
2. 点击「项目设置」→「AI 知识库」
3. 勾选「为本项目启用 AI 知识库」
4. 自定义欢迎语（可选）
5. 保存配置

保存后，系统会自动开始构建项目知识库（索引所有文档），通常需要几分钟。构建完成后即可使用。

普通用户：使用助手

开启后，所有能访问该项目的用户都可以使用：

1. 打开项目主页
2. 点击右下角的知识库助手图标
3. 在对话框中输入问题，按回车发送
4. 查看返回的答案和来源文档链接

提问建议：

• 问题具体明确："用户登录接口的请求参数有哪些？"
• 可以分步提问："先告诉我有哪些模块？"→"订单模块的主要功能是什么？"
• 避免过于宽泛："告诉我所有的接口"

安全与隐私

• 知识库隔离：每个项目都有独立的知识库，助手只能访问该项目的文档
• 权限继承：助手遵循项目的访问权限
  • 公开项目：所有人可用
  • 私有项目：仅项目成员可用
  • 密码保护：输入密码后才能使用

适用场景

• API 文档项目：查询接口信息
• 产品说明文档：解答功能使用问题
• 技术规范文档：查找开发标准和流程
• 运维手册：查找故障排查方法
• 培训文档：辅助新人学习

官网地址： https://www.showdoc.com.cn/