AIOps Docs
知识库
知识库
  • 开篇

    • 1. 项目概述
    • 2. 快速上手
    • 3. 核心理念
  • 场景

    • 4. 历史项目入库
    • 5. 文档召回辅助研发
    • 6. 日常文档维护
    • 7. 新项目初始化
  • How it works

    • 8. 治理模型
    • 9. 三级结构
    • 10. 迭代绑定
    • 11. config-ui
  • 资料

    • CLI 命令参考
    • 技能说明
    • 知识生命周期(总调度)
    • 治理引导
    • 历史项目入库
    • 文档召回辅助研发
    • 日常文档维护
    • 新项目简报
    • 知识审查

项目概述

AIOps 知识治理是一套面向人和 AI coding agent 的项目知识基础设施。它从初始化、生成、召回到维护形成闭环:人通过阅读层理解项目,agent 通过阅读层进入业务语境,再用源码和图谱确认实现事实。

这篇文章概述 AIOps 知识治理的全貌:包含什么、怎么组织、以及各部分如何协同工作。

四个场景

AIOps 知识治理按输入来源和使用方向分成四个核心场景。它们共享同一套 .aiops/projects/<project>/ 知识结构,不管从哪个入口进入,产出的文档都能被其他场景复用。

历史项目入库

输入:已有代码、配置、测试、旧文档、Git 历史、图谱。方向:从证据逆向生成人类阅读层。

接手一个维护了几年的老项目?文档散落在 README、Wiki、设计文档里?这个场景借鉴 skills-seed 的工作原理,从源码、配置、测试、Git 历史和图谱出发,逆向提炼项目边界、模块职责、业务链路和关键决策。重点是区分"能证明的事实"和"看起来很合理的推测"。

详见 历史项目入库

文档召回辅助研发

输入:研发任务 + 人类阅读层 + 源码图谱。方向:先理解业务,再确认实现事实。

开发、调试、评审、解释和写测试之前,agent 先读取项目迭代绑定,再按项目、产品、微服务召回阅读层,随后回到源码、CodeGraph 和 Understand Anything 核验证据。目标是让 agent 带着业务上下文改代码,以实现证据为准。

详见 文档召回辅助研发

日常文档维护

输入:git push hook + 未分析 commits + 图谱影响面。方向:随代码提交增量更新阅读层。

文档写完就过时?这个场景在 git push 时启动 Claude Code 维护任务,读取 commit-analysis.md 找到上次已分析提交,再分析本次未分析 commits,根据源码和图谱影响面做跨文档一致性更新。

详见 日常文档维护

新项目初始化

输入:PRD、会议记录、需求文档、用户回答。方向:从用户引导建立阅读层骨架。

新项目从第一天就建立知识治理骨架——项目边界、产品和微服务边界、迭代绑定、平台 Hook 配置。不等代码写完了再回头补文档。初始化是幂等的,可以反复执行来补全结构。

详见 新项目初始化

三个工具

CLI 在安装时会检查并自动补齐三个辅助工具到 ~/.aiops/tools/。工具链为可选,可通过 --with none 跳过;在代码理解和上下文注入场景中默认推荐安装。

工具版本用途
CodeGraph0.9.9Agent 事实层:代码调用关系、调用方、被调用方和影响范围
Understand Anything2.7.6Agent 事实层:从源码提炼项目结构、架构层和业务概念
Trellis0.5.19任务执行和上下文注入层(辅助,不作为事实源)

安装程序会先汇总本地工具链版本和缺失项。交互式终端询问是否自动补齐;带 --yes 时自动补齐。

七个技能

治理体系包含 7 个独立技能,由一个总调度技能按场景路由:

aiops-knowledge-lifecycle(总调度)
  ├── aiops-governance-bootstrap(治理初始化)
  ├── aiops-historical-project-intake(历史项目入库)
  ├── aiops-dev-context-recall(文档召回辅助研发)
  ├── aiops-daily-doc-maintenance(日常维护)
  ├── aiops-new-project-briefing(新项目初始化)
  └── aiops-knowledge-review(质量审查)

大多数情况无需手动选择技能。对 agent 说"帮我整理项目知识库"或"先召回文档辅助研发",lifecycle 会根据意图自动路由到正确的子技能。

技能触发语做什么
知识生命周期"整理知识库""更新文档""审查知识"等路由到正确的子技能
治理引导"初始化 AIOps""安装治理工具"安装技能、初始化 .aiops/ 结构
历史项目入库"整理这个项目的知识库"从已有代码逆向生成知识文档
文档召回辅助研发"先召回文档""按知识库辅助研发"召回项目上下文作为开发约束
日常文档维护git push、"分析提交并更新文档"根据未分析 commits 跨文档同步更新
新项目简报"为新项目初始化知识库"从需求输入建立知识骨架
知识审查"审查知识库""检查文档质量"检查完整性、一致性、agent 可用性

详见 技能说明

三个 Hook

Hook 是连接代码活动和知识维护的桥梁。目前在 Claude Code 和 Codex 两个平台上实现。Hook 只负责记录和触发,不改文档——理解语义、判断影响面、更新文档由维护 agent 完成。

Hook触发时机做什么
aiops_inject_context任务开始时注入项目知识库上下文给 agent
aiops_push_maintenancegit push 前启动 Claude Code 分析未分析提交并维护阅读层

Hook 配置通过 CLI 的 init 命令写入平台配置文件(.claude/settings.json 和 .codex/hooks.json),写入是幂等的。源码仓库可通过 link-docs 命令将 hook 事件投递到独立的文档仓库。

详见 治理模型 了解 Hook 机制和治理等级的完整说明。

关键设计

开始使用之前,以下是几个贯穿整个方案的核心概念。

治理以项目为单位

传统文档的问题在于管理粒度太细——每篇文章是独立的,互不关联。AIOps 以项目为治理单位,并在项目下细分产品和微服务。项目级文档描述迭代和共同约束,产品级文档描述产品版本和能力边界,微服务级文档描述单个代码服务的职责、流程、架构角色和源码图谱入口。

两层语义

Agent 和人需要的信息不同。人需要连续叙事和背景解释;agent 需要业务入口,也需要可验证的实现事实。因此每个项目有两层语义:

  • 人类阅读层:.aiops/projects/<project>/ 和 guides/,写项目、产品、微服务、架构、流程、ADR、风险和开放问题。
  • Agent 事实层:源码、测试、配置、Git 历史、CodeGraph 和 Understand Anything,验证接口、配置、数据结构、调用链和影响面。

两层不互相替代。阅读层不维护 Markdown specs/;代码 + CodeGraph 是最好的实现 spec。

Hook 做记录,Agent 做判断

代码变更提交后,源码仓库的 push hook 启动 Claude Code。Hook 不直接改文档——它只负责传递 push 范围;判断影响面、决定更新哪些文档、实际修改内容、推进 commit-analysis.md,这些由维护 agent 完成。

治理等级控制自动化程度

不同团队对文档治理的强度需求不同。AIOps 用四个等级控制自动化程度:low(只记录)、medium(温和提醒)、high(异步维护,默认)、xhigh(同步维护)。大多数项目用 high 就够了。

进一步阅读

  • 快速上手 — 从零开始,五分钟完成安装和初始化
  • 核心理念 — 为什么这样设计,解决了什么问题
  • 治理模型 — 治理等级、Hook 机制、文档粒度、工具链协同
  • 项目、产品、微服务三级结构 — 文档落点和上下游关系写法
  • 迭代绑定 — 项目迭代、产品版本和微服务主分支如何绑定
  • 技能说明 — 每个技能的触发条件、执行步骤和完成标准
  • CLI 命令参考 — 所有命令和选项的完整说明
最近更新: 2026/6/16 16:28
Contributors: Makia98, Makia9879
Next
2. 快速上手