新项目简报
aiops-new-project-briefing 在新的或早期项目中建立知识治理骨架。不等代码写完了再回头补文档——从第一天就把知识结构搭好。
适用场景
- 刚启动的新项目,只有需求文档或会议记录
- 项目还在早期,代码不多,想先把知识结构建起来
- 从 PRD 出发,想在写代码之前把关键决策和架构方向定下来
输入来源
- 产品需求文档(PRD)
- 会议记录、讨论笔记
- 用户故事、功能列表
- 技术方案草图
- 团队的口头说明
执行步骤
确认
.aiops/已初始化——没有的话先调aiops-governance-bootstrap收集所有可用的输入材料
按优先级建立文档:
优先级 文档 说明 1 project.yaml项目标识、产品注册表、治理等级、语言 2 iteration-bindings.yaml项目迭代、产品版本、微服务主分支 3 README.md导航索引,不做长篇叙事 4 iterations/项目迭代目标、范围、风险 5 products/<product>/产品版本、产品能力、产品内架构 6 products/<product>/services/<service>/服务接口、模型、流程、验证入口 7 guides/docs/给人看的概述、接入指南、变更流程 8 open-questions.md未解决的决定
内容标注
新项目初期,很多信息是不确定的。每一条写入 canonical 文档的内容都要标注可信度:
| 标注 | 含义 | 示例 |
|---|---|---|
Confirmed | 用户明确提供或团队已达成一致 | "使用 PostgreSQL 作为主数据库(团队决策,2024-03-15)" |
Assumption | Agent 根据上下文推断,但未经确认 | "推测用户认证采用 JWT 方案(基于 PRD 中提到的无状态 API 要求)" |
Unknown | 缺失的决策,需要有意识地记录 | "消息队列选型待定(Kafka vs RabbitMQ vs SQS)" |
这些标注会在后续维护和审查中持续被检查和升级——执行 aiops-daily-doc-maintenance 或 aiops-knowledge-review 时,Assumption 和 Unknown 会被重新评估。
关键原则
别等到"都有了再写"
新项目最容易犯的错误是"等设计定下来再写文档"。但设计永远在变。正确的做法是把已经确定的写进去,不确定的标出来,让知识库和项目一起成长。
骨架比内容重要
初始化时最重要的是把结构建对——项目、产品、微服务三级目录建好,project.yaml 和 iteration-bindings.yaml 配好,Hook 装好。结构对了,填内容是日常开发中水到渠成的事。结构不对,后面填的内容很难被 agent 有效召回。
面向 agent 写作
Canonical 文档不需要"好看"。它需要:
- 路径稳定,agent 能找到
- 事实直接,不埋在叙事里
- 引用具体,指向源码路径或配置项
- 不确定的标注清楚,不假装全知道
人想看好看的文档去 guides/,那是给人读的。
完成标准
一次合格的新项目初始化:
- workspace 和 project 边界清楚
- 产品和微服务已被记录(哪怕一开始只有
core) iteration-bindings.yaml已表达项目迭代、产品版本和微服务主分支- 项目、产品、微服务三级文档落点已建立
- 所有内容已标注可信度(Confirmed / Assumption / Unknown)
- guides 可服务人类阅读
- Claude Code 和 Codex Hook 已配置
- 默认配置足够可用,不需要先理解整套治理理论