ShowDoc一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册https://www.showdoc.com.cn/help/11559060627294221内置的AI 智能体

ShowDoc AI 智能体是一个内置的对话式助手,通过自然语言就能完成文档的问答、搜索、创建、编辑和项目管理。

它不只是”能聊天的机器人”,而是能真正动手帮你建文档、改文档、管项目的智能体。


快速开始

打开方式

在 ShowDoc 任意页面,点击屏幕右下角的机器人图标即可打开 AI 对话框。

  • 项目内打开时,AI 会感知当前项目上下文,可以基于项目内容回答问题
  • 非项目页面(如首页、项目列表)打开时,AI 处于全局模式,支持跨项目搜索和通用问答(需登录)

第一句话该怎么问

不知道从哪开始?试试这些:

  • “这个项目里有哪些文档?”
  • “帮我搜索一下关于登录接口的内容”
  • “创建一个页面,标题叫《部署指南》,内容写……”
  • “把所有页面里的 old.example.com 替换成 new.example.com
  • “看板里有哪些待办任务?”

它能做什么

1. 直接问,不用翻目录

不知道某个流程、某个配置、某个接口怎么用,直接问。AI 会读取项目里的文档内容来回答你,并在答案后面附上可点击的来源链接,一键跳到原文。

比在目录树里一层层点开、靠关键词猜标题要快得多。新同事查资料、老同事回忆半年前的设计,都能少走弯路。

2. 跨项目搜索

东西在哪个项目里都记不清?AI 能在所有你有权限的项目里一起搜,标题和正文都能查,告诉你答案落在哪个项目的哪个页面。

跨项目搜索需要在全局模式下使用(在非项目页面打开 AI)。

3. 批量建文档、批量改文档

这是 AI 智能体最能”动手”的地方,不只是回答你。

批量建:需要一次性建一批文档时,把内容丢给 AI,它一次性帮你建好,同标题的会更新而不是重复创建。需求拆成若干条目、长文档拆成多页、一批接口一次性建好,都比手动逐个建轻松。

手里有 OpenAPI / Swagger 文件的,也可以直接让 AI 导入,自动解析成接口页面。

批量改:全项目要统一改一个点时最有用,比如——

  • 把所有文档里的旧域名换成新域名
  • 给一批接口文档统一补上错误码说明
  • 把一堆没归类的文档,按内容整理进对应目录
  • 把一批文档的标题或格式统一规范

你告诉 AI”改什么、改成什么样”,它会先搜出来,再逐个更新。几十上百页一次处理完,不用手动一篇篇点开改。

不放心的话,每页都有历史版本记录,批量改完也能逐页回退,改错了不丢东西。

4. 在编辑器里直接帮你改稿

写到某一页时打开 AI,把当前内容交给它。让它帮你润色、补全、改格式、翻译、甚至重写一段,改完能直接写回当前页,省去复制粘贴和来回切换。

5. 用对话管理项目和看板

  • 项目管理:新建项目、调整目录、给文档归档,一句话就能完成
  • 看板管理:创建任务、改状态、移到别的列表,也不用再点来点去
  • RunApi 接口:在 RunApi 项目里用对话创建和更新接口页面

谁能用、能做什么

不同身份的用户,AI 的能力范围不同:

项目成员

能力 说明
问答与搜索 项目问答、项目内搜索、跨项目全局搜索、浏览目录结构
读写文档 创建/更新/批量创建页面、导入 OpenAPI、在编辑器中改稿
管理看板 创建/更新/移动任务、添加列表(删除类操作需管理员权限)
查看历史 查看页面历史版本、对比版本差异、恢复历史版本

项目成员的编辑权限受项目角色控制:有编辑权限的成员可以写文档,项目管理员可以执行删除操作。

游客(未登录访客)

很多团队会把 ShowDoc 当成对外文档站、帮助中心或产品手册。这些场景下,访客是没登录的游客。

AI 智能体可以对游客开放(需项目创建者手动开启)。游客打开项目后就能直接提问,AI 只做检索和回答,告诉他文档里写了什么、东西在哪、怎么操作,并附上来源链接跳转。

游客侧的 AI 是只读检索,不能建文档、改文档、动任务,只是把文档内容检索出来回答你。能不能开放、开多大范围,由项目方自己控制。


配额与积分

怎么计费

AI 按实际 token 消耗计费,1 积分 = 1000 tokens,向上取整。双层额度保障使用:月赠送额度用完后自动消耗积分余额,两者都耗尽则停止。

  • 积分永久有效,不会过期
  • 月赠送额度每月刷新

谁的额度被消耗

场景 消耗谁的额度
全局 AI(非项目页面) 你自己的额度
项目内 AI 项目创建者的额度
游客提问 项目创建者的额度(受游客配额上限约束)

项目内 AI 消耗的是项目创建者的额度。如果创建者额度耗尽,会自动回退到消耗当前操作者的个人额度。

月赠送额度(按用户等级)

用户等级 每月赠送积分
普通用户 50
VIP 1 200
VIP 2 800
VIP 3 3000

额度用完后可以单独购买积分,积分永久有效。

游客配额(项目级控制)

项目创建者可以在「AI 助手设置」中配置:

  • 是否对游客开放 AI:默认关闭,需手动开启
  • 游客每月积分上限:0 表示不限制(但仍受创建者总额度约束)

使用技巧

让 AI 更好地理解你的需求

AI 越清楚上下文,结果越准:

  • 在项目内问:在对应项目页面打开 AI,AI 自动感知项目上下文
  • 指明范围:”在这个项目的《API 文档》目录下搜索……”
  • 给完整需求:批量建文档时,把每条的标题和内容都写清楚
  • 给替换规则:批量改时说清楚”找什么、换成什么”,AI 会先搜再改

常见使用场景示例

场景一:批量建文档

“我有一批需求要录入。创建以下页面,标题分别是《用户注册》《用户登录》《密码找回》,每个页面的内容如下……”

场景二:批量替换

“把项目里所有页面出现的 http://10.0.0.1 全部改成 https://api.example.com,先搜出来给我看看有哪些,再逐个更新”

场景三:从代码注释生成文档

“根据这段代码注释帮我生成一份 API 文档页面:(粘贴注释内容)”

场景四:导入 Swagger 文档

“把这个 OpenAPI 文件导入进来,每个接口生成一个页面:(粘贴 JSON 内容)”

场景五:看板管理

“看板里新增一个任务,标题《修复登录页 Bug》,放到待办列表,优先级设为高,截止日期 2026-01-15”

场景六:让 AI 帮你改稿

“帮我润色一下这段内容,让它读起来更通顺,语气更专业一些,改完写回当前页面”


常见问题

AI 回答的内容找不到来源?

AI 回答时会在末尾附上来源链接(蓝色可点击),点击即可跳转到原文。如果没有来源链接,说明 AI 基于自身知识回答的,不一定准确,建议明确指明”根据项目文档回答”。

批量改文档改错了怎么办?

每个页面都有完整的历史版本记录。进入对应页面 → 查看历史版本 → 找到修改前的版本 → 恢复即可。批量操作改错了不丢东西。

为什么游客打不开 AI?

游客 AI 需要项目创建者手动开启。路径:进入项目 → 右上角下拉菜单 →「AI 助手设置」→ 开启「游客 AI」开关。开启后游客才能在项目页面使用 AI 问答。

看板项目里 AI 怎么用?

看板项目(item_type=6)不用普通文档工具,AI 会自动切换到看板工具。你只需要用自然语言描述需求,比如”新建任务””把任务移到进行中””搜索包含’登录’的任务”。

RunApi 项目能用 AI 吗?

可以。AI 支持在 RunApi 项目里创建和更新接口页面,也支持通过 OpenAPI/Swagger 文件批量导入接口。但 RunApi 项目暂不支持在编辑器中用 AI 改写已有接口内容。

配额用完了怎么办?

  • 普通用户每月有免费赠送额度,用完自动消耗积分余额
  • 积分余额也为零时,AI 会提示配额不足,需要充值积分或等待下月额度刷新
  • 如果你是项目成员但提示配额不足,可能是项目创建者的额度用完了,可以联系创建者

AI 生成到一半中断了?

可能是触发了以下限制:

  • 单次对话积分上限:默认 200 积分,超限自动截断
  • 工具调用轮次上限:最多 20 轮工具调用,复杂任务可能需要分多次完成
  • 手动停止:你可以随时点击「停止生成」中断,但已消耗的 token 照扣

遇到截断时,可以继续追问”继续刚才的操作”来接着完成。

如何开启或关闭项目的 AI 功能?

项目创建者可以在项目设置中控制:

  • 进入项目 → 右上角下拉菜单 →「AI 助手设置」
  • 可以开启/关闭 AI、配置游客访问、设置欢迎语等

注意事项

  • AI 生的内容建议检查后再采用,尤其是技术细节,AI 可能会出错
  • 每页都有历史版本,批量操作改错了可以回退
  • 单条消息长度上限默认 8000 字,超长内容建议分段发送
  • AI 对话历史会自动保留,但超长时间不活跃的会话会被清理
  • 敏感内容(含违禁关键词)会被拦截,不会入库也不会被 AI 处理
Logo

DAMO开发者矩阵,由阿里巴巴达摩院和中国互联网协会联合发起,致力于探讨最前沿的技术趋势与应用成果,搭建高质量的交流与分享平台,推动技术创新与产业应用链接,围绕“人工智能与新型计算”构建开放共享的开发者生态。

更多推荐