每个文档工具都能托管文章,却没有一个知道已合并的 PR 刚刚让某篇文章失效。Ellie Docs 连接您的 GitHub 仓库,追踪每篇文章真正依赖的代码,并在文章过时的那一刻标记出来,然后起草修订。
无需绑卡 · 可使用 Google、Microsoft、GitHub 或邮箱注册
API 里的一个字段改了名,某个端点被弃用,某个界面流程被重新设计。PR 顺利合并,测试通过,而引用旧行为的帮助文章依然摆在那里:看起来正确,实则悄悄出错,直到被客户或支持工单发现。
每篇文章都可以关联到它所记录的代码、端点或 API 规范,因此 Ellie Docs 清楚地知道该盯着什么。
GitHub App 监视已合并的 PR,判断它们是否影响某篇关联文章并加以标记,同时附上起草好的修订供审阅,而不只是一个红色提示条。
有 OpenAPI 规范?Ellie 让参考文档与之保持同步,并在每个版本上比对是否存在破坏性变更。没有规范?它会根据您的路由和请求校验器推导出一份,并为每个字段标明所依据的代码。
在您的产品文档所依赖的仓库上安装 Ellie Docs GitHub App。我们不保留您仓库的副本:代码只在 Ellie 需要读取时获取,之后按提交重新获取。
通过抓取导入已有文档,或从零开始。Ellie Docs 会起草文章,并把每篇文章关联到它所依赖的代码、端点或规范。
当某次合并影响到关联文章时,Ellie 会标记并起草修订。您的团队审阅的是一份待处理的修复建议队列,而不是到处找哪里出了问题。
一个仅限于您所选仓库的 GitHub App。我们不保留您仓库的副本:Ellie 在需要读取时获取文件树,之后按提交重新获取。保留下来的是支撑文章的衍生材料,即每条论断背后的摘录和引用,这样您文档中的任何一句话都能追溯到佐证它的代码。文件中发现的密钥会在存储前被脱敏,您的代码也绝不会用于训练模型。
会,这正是设计意图。Ellie Docs 直接托管并渲染公开的帮助中心,包括自定义域名,您不必同时运行两套系统。
可以。把规范交给 Ellie Docs,它会据此维护参考文档,并随着 API 演进与每个新版本比对。没有规范时,Ellie 会从您的代码推导:端点来自路由,字段类型来自请求校验器;对于代码没有明确写出的内容,则通过调查得出,并且必须引用各字段所依据的代码行。推导出的端点在您审阅之前保持私有,因此内部路由不会泄露到公开的参考文档中。
可以搭配 Ellie Desk(抢先体验中)使用:已解决的支持工单可一键变成新的文档文章,Desk 的 AI 草稿也会自动基于您已发布的文档。
提供免费方案,付费方案按年付款每月 $65 起。 查看价格 →