ReadMe AI 员工

Leina 连接 ReadMe,帮你查找文档、修改指南、准备更新日志。在团队聊天中交代任务,Leina 完成工作,再把结果带回来。

连接 ReadMe,选择要共享的内容,就可以交代第一项任务。

Leina + ReadMe 结果示例

你

创建隐藏的更新日志,标题为“春季更新”:现已支持保存筛选条件,并修复导出错误。

Leina

已创建更新日志,并保持隐藏供审核。

ReadMe · 更新日志草稿

春季更新

已创建隐藏条目,整理本次发布变更。

新增
保存筛选条件,复用常用视图。
修复
修复导出结果时的错误。
把更新日志准备好,等你审核。

什么是 ReadMe AI 智能体?

ReadMe AI 智能体可以核对指南、应用修订正文,或按指定可见性创建更新日志。

你指定资料来源和保存位置。Leina 使用连接有权访问的内容完成任务,再把结果交给你检查。

ReadMe

ReadMe 用于托管产品文档、API 参考和更新日志。

  1. 提供发布说明

    说明标题、变更和可见性。

  2. 创建条目

    在 ReadMe 中保存更新日志。

  3. 发布前审核

    公开前检查隐藏条目。

可以交给 Leina 的 ReadMe 任务

复制示例,补充具体信息,然后在已接入的团队聊天中发给 Leina。

研究文档

读取文档版本 [版本] 中的指南 [页面标识],总结前置条件和操作步骤。

readme

修改指南页面

读取版本 [版本] 中的指南 [页面标识],用以下完整修订稿替换正文:[正文]。

readme

创建更新日志

根据发布说明 [说明] 创建更新日志,标题为 [标题],设为 [隐藏或公开]。

readme

下一项 ReadMe 工作,从一条消息开始。

连接工具,交代任务,查看结果

在团队聊天中告诉 Leina 你的需求,说明数据来源、保存位置和预期结果。

  1. 连接账号

    连接任务涉及的工具,让 Leina 访问需要的内容。

  2. 尝试一个任务

    提供资料来源、结果的保存位置,以及你希望完成的工作。

  3. 核对结果

    查看任务结果,并核对应用中的变更。

让 Leina 在 ReadMe 中动手完成工作

把这些日常工作交给你的 AI 员工。

Get Project

获取与 API 密钥关联的 ReadMe 项目的元数据。

List Versions

列出为 ReadMe 项目配置的版本。

Get Version

按 semver 标识符获取一个 ReadMe 项目版本。

Create Version

从现有基础版本创建新的 ReadMe 项目版本。

Update Version

按 semver 标识符更新一个 ReadMe 项目版本。

Delete Version

按 semver 标识符删除一个 ReadMe 项目版本。

List Categories

列出 ReadMe 指南和参考类别,支持可选的版本和分页。

Create Category

创建 ReadMe 指南或参考类别。

Get Category

按 slug 获取一个 ReadMe 类别。

Update Category

按 slug 更新一个 ReadMe 类别。

Delete Category

按 slug 删除一个 ReadMe 类别。

List Category Docs

列出属于某个类别 slug 的 ReadMe 文档。

Search Docs

按文本查询搜索 ReadMe 文档。

Create Doc

使用类别 ID 或类别别名创建 ReadMe 文档页面。

Get Doc

按别名获取一个 ReadMe 文档,可选择请求生产文档版本。

Update Doc

按别名更新一个 ReadMe 文档页面。

Delete Doc

按别名删除一个 ReadMe 文档页面。

List Custom Pages

列出 ReadMe 自定义页面,支持可选分页。

Create Custom Page

创建 ReadMe 自定义页面。

Get Custom Page

按别名获取一个 ReadMe 自定义页面。

Update Custom Page

按别名更新一个 ReadMe 自定义页面。

Delete Custom Page

按别名删除一个 ReadMe 自定义页面。

List Changelogs

列出 ReadMe 变更日志条目,支持可选分页。

Create Changelog

创建 ReadMe 变更日志条目。

Get Changelog

按别名获取一个 ReadMe 变更日志条目。

Update Changelog

按别名更新一个 ReadMe 变更日志条目。

Delete Changelog

按别名删除一个 ReadMe 变更日志条目。

List Api Specifications

列出 ReadMe API 规范元数据,支持可选版本和分页。

Delete Api Specification

按 ID 删除一个 ReadMe API 规范。

Get Api Registry

按 UUID 检索一个 ReadMe API Registry 条目。

Get Openapi Schema

获取 ReadMe 项目的 OpenAPI 定义。

List Outbound Ips

列出用于 Webhook 和 Try It 代理请求的 ReadMe 出站 IP 地址。

Ask Owlbot

向 ReadMe Owlbot 提出非流式问题,并返回带来源的答案。

为你的 AI 员工连接更多工具

连接工作中使用的 App,让 Leina 获取任务需要的信息,继续推进工作。

讨论继续往前走, Leina 接手具体工作。

在团队讨论中交代任务。Leina 使用已连接的工具完成工作,再回到聊天中交付结果。

了解 Leina 如何在 Slack 中工作
Leina结果示例

已创建更新日志,并保持隐藏供审核。

春季更新

关于 ReadMe 和 Leina,你可能还想知道

可以选择修改哪个文档版本吗?

可以,请同时指定指南和版本,确保修改正确的发布版本。

修改指南会追加到旧正文后吗?

正文更新会替换页面文本,需要将保留的原有章节包含在修订稿中。

让 Leina 成为你的 ReadMe AI 员工

从手头的一项工作开始。告诉 Leina,你想要什么样的结果。

连接 ReadMe,选择要共享的内容,就可以交代第一项任务。