为 AI 辅助开发的工程团队提供开箱即用的项目知识治理能力。
当你的团队使用 Claude Code、Codex 等 AI coding agent 进行日常开发时,一个常见的问题是:Agent 不了解你的项目。它不知道你的 PRD 写了什么、架构如何设计、有哪些历史决策、术语表在哪。
AIOps Docs 解决的就是这个问题 — 它通过一行命令在你的项目中建立一套标准化的知识治理基础设施,让 coding agent 能够:
- 在开发前自动加载项目背景、架构和术语
- 在代码变更后记录影响范围,提醒维护相关文档
- 在例行维护中检查跨文档一致性
- 在接手历史项目时从代码逆向生成知识库
一句话:让 AI 真正理解你的项目,而不是每次都从零开始。
在你的项目根目录执行:
npx -y @makia9879/aiops setup --yes --project my-project这条命令会完成两件事:
- 安装技能 — 将 6 个 AIOps 治理技能部署到 Agent 运行时目录
- 初始化工作空间 — 在项目下创建
.aiops/目录,生成知识管理所需的全部结构
之后,你的 AI coding agent 就具备了项目知识治理能力。
不加 --yes 可以使用问答模式,按需定制:
npx -y @makia9879/aiops setupCLI 会引导你完成项目名称、产品域、治理等级、文档语言等配置。
你的项目/
├── .aiops/
│ ├── governance.yaml # 治理配置(等级、语言、产品域)
│ ├── hooks/ # Agent Hook(注入上下文、记录变更、触发维护)
│ ├── projects/my-project/ # 项目知识库
│ │ ├── project.yaml # 项目元信息
│ │ ├── README.md # 知识库索引
│ │ ├── open-questions.md # 待解决问题
│ │ ├── prd/ # 产品需求文档
│ │ ├── architecture/ # 架构文档
│ │ ├── specs/ # 技术规格
│ │ ├── adr/ # 架构决策记录
│ │ ├── workflows/ # 工作流文档
│ │ └── guides/ # 人类可读的开发指南站点(VuePress)
│ └── diff-records/ # 变更记录(Agent 自动维护)
└── .claude/settings.json # Claude Code Hook 配置(自动追加)
| 场景 | 对应技能 | 触发方式 |
|---|---|---|
| 新项目初始化 | aiops-new-project-briefing |
主动调用,从需求/PRD 生成知识库 |
| 历史项目入库 | aiops-historical-project-intake |
主动调用,从已有代码逆向生成知识库 |
| 日常文档维护 | aiops-daily-doc-maintenance |
Hook 自动触发,基于代码变更维护文档 |
| 知识审查 | aiops-knowledge-review |
定期执行,检查完整性和一致性 |
# 仅安装技能(不初始化工作空间)
npx -y @makia9879/aiops install
# 仅初始化工作空间(不安装技能)
npx -y @makia9879/aiops init --yes --project my-app
# 跳过工具链,只安装技能 + 初始化
npx -y @makia9879/aiops setup --yes --with none --project my-app
# 指定产品域和语言
npx -y @makia9879/aiops setup --yes --project cert-auth --products CA,RA,KMC,OCSP --language zh-CN
# 指定治理等级(low / medium / high / xhigh)
npx -y @makia9879/aiops setup --yes --project my-app --level high| 选项 | 说明 | 默认值 |
|---|---|---|
--yes, -y |
跳过交互问答,使用默认值 | 关闭 |
--project <id> |
项目标识 | 自动从 package.json 推断 |
--products <list> |
产品域,逗号分隔 | core |
--level <level> |
治理等级:low / medium / high / xhigh |
high |
--language <lang> |
文档语言 | zh-CN |
--with <tools> |
辅助工具链:default / none / 逗号列表 |
default |
初始化后,每个项目自带一个可本地预览的开发指南站点:
cd .aiops/projects/<project>/guides
docker compose up
# 打开 http://localhost:8080站点基于 VuePress,面向人类阅读者,内容从 canonical 知识文档自动关联。
- Node.js ≥ 18(仅用于运行 CLI)
- Docker(用于启动文档站点和辅助工具)
- 支持的 AI Agent 平台:Claude Code、Codex
- 架构决策记录 — 了解设计决策背后的原因
- CONTEXT.md — 术语定义与运行上下文
- CLI 详细文档 — 开发者视角的 CLI 说明