跳到主要内容

知识库

AI 代理的能力取决于你提供的上下文。知识库是存储架构决策、API 规格和领域知识的地方,代理在实施时会引用这些信息。没有记录下来的上下文,代理只能猜测。有了它,代理就能基于你的实际情况作出明智决策。

Almirant 知识库是一个集成式文档系统,团队可在其中创建、组织和搜索 Markdown 格式的文档。文档按层级分类分组,关联到项目和工作项,并为 AI 提供额外上下文。

什么是文档

文档是使用 Markdown 编写的内容页面。它可以是技术规格、流程指南、会议记录、架构决策,或团队需要共享和查阅的任何知识。

每个文档属于一个分类,并可关联到一个或多个项目。

创建文档

从文档部分单击 新建文档。填写字段:

字段必填描述示例
标题文档的描述性名称“生产环境部署指南”
内容Markdown 格式的文档正文带格式的文本、列表、表格等
分类层级树中的分类“技术指南 > 基础设施”
项目文档关联的项目“移动应用 v2”

Markdown 编辑器

编辑器支持完整的 Markdown 语法:

  • 标题######
  • 有序和无序列表
  • 表格
  • 带语法高亮的代码块
  • 粗体斜体及其他内联格式
  • 链接和图片

编辑器底部会显示字数统计,以便了解文档篇幅。

层级分类

文档按具有无限深度的分类树组织。这使你能够创建所需的详细结构:

文档
├── 技术指南
│ ├── 基础设施
│ ├── 数据库
│ └── API
├── 流程
│ ├── 入职
│ └── 发布管理
├── 架构决策
└── 会议记录
├── 冲刺评审
└── 规划

创建分类

  1. 在文档侧边树中,单击 新建分类
  2. 输入分类名称。
  3. 可选择父分类以创建子分类。

树形导航

文档部分的左侧边栏显示完整分类树。单击某个分类可查看其中的文档。包含子分类的分类可以展开和折叠。

全文搜索

文档搜索允许你按全文查找内容。它会在标题和正文中搜索,并按相关性排序返回结果。

在文档部分的搜索栏中输入查询,以实时筛选列表。

与工作项关联

文档可以与工作项双向关联。这适用于:

  • 将技术规格关联到实施它的用户故事。
  • 将架构决策关联到产生它的史诗。
  • 将会议记录与由此产生的任务连接起来。

从文档关联

在文档详情中,找到 关联工作项 部分,添加要关联的工作项。

从工作项关联

在工作项详情中,可以从相应部分关联现有文档。

关联是双向的:如果将文档关联到工作项,也可从工作项看到该文档的引用。

置顶(pinning)

可以置顶重要文档,使其突出显示在列表顶部。这适用于常用参考文档,例如风格指南、关键流程或入职文档。

要置顶文档,请使用列表或文档详情中的图钉图标。

跨项目分组

文档可以关联到多个项目,从而创建适用于多个团队或计划的跨领域文档。例如,“代码标准”文档可关联到所有开发项目。

版本历史记录

Almirant 会自动保存每个文档的先前版本。每次保存更改时,系统都会在 S3 中创建一个新版本。你可以:

  • 查看文档的版本历史记录。
  • 查阅先前版本的内容。
  • 确定何时进行了哪些更改。

文档作为 AI 上下文

知识库文档可作为通过 MCP 连接的 AI 代理的额外上下文。当代理需要理解规格、流程或架构决策时,可以查阅项目中的相关文档。

将文档与工作项结合时尤其有效:AI 可在实施工作项之前阅读与之关联的技术规格。

开发者指南

文档可通过 MCP 使用:

工具描述
list_documents列出按项目和分类筛选的文档
list_document_categories列出可用的层级分类

可通过 MCP 访问的文档使 AI 代理能够查询团队知识库,从而在实施过程中作出更明智的决策。例如,在实施工作项前,代理可以搜索相关的技术规格或架构决策。


相关内容:项目 | 工作项