E-Flow:项目专家文档框架
让 AI 真正"懂"你的项目——把项目的架构、铁律、环境与关键事实,变成一份 AI 每次对话都自动携带的专家档案。
这是什么?
E-Flow(Expert Document Framework,专家文档框架)是 qqqide 内置的一套项目文档体系。
当你的项目比较复杂时(多语言、多模块、有特殊约定),AI 每次进入项目都像是"新来的同事"——你不希望它每次都要重新摸索,也不希望它靠猜测行事。E-Flow 做的事情是:把项目的核心知识沉淀成结构化文档,并注入到 AI 的每一次对话上下文中,让 AI 从一开始就站在"老员工"的视角工作。
它能解决什么问题?
| 问题 | 没有 E-Flow | 有 E-Flow |
|---|---|---|
| AI 不了解项目架构 | 每次都要现读代码摸索 | 开局就带着架构地图 |
| 项目有硬性约定(铁律) | AI 可能无意违反 | 铁律直接进上下文,默认遵守 |
| 环境变量、密钥、部署方式 | 反复口头交代 | 一次写清,永久生效 |
| 项目关键事实 | AI 容易忘记 | 每次都自动注入 |
文档结构
E-Flow 在项目下建立expert/ 目录,包含一个薄索引和若干档案文件:
project/_qqq/alphal/expert/
├── index.md ← 薄索引(总览 + 指向各档案)
└── arch/
├── topology.md ← 项目架构(目录结构、模块关系、数据流)
├── iron_law.md ← 铁律(不可违反的硬性约束)
├── env_var.md ← 环境变量 / 密钥 / 部署信息
└── facts.md ← 关键事实(项目身份、仓库、团队、里程碑)
- 薄索引:只放目录和指针,不长篇大论——这样注入上下文的开销极小,AI 按需读取详细档案。
- 档案文件:每个主题一个文件,AI 根据任务需要去读对应档案。
工作方式
E-Flow 遵循一个简单的状态机:
未启用 → 待引导 → 标准模式 → 自定义模式
- 新项目首次启动:qqqide 检测到项目尚无专家文档时,自动创建骨架(上述标准结构),并自动进入标准模式——引导过程只在主面板的首次对话触发一次,之后不再打扰。
- 标准模式:AI 自动加载
expert/index.md,按需读取arch/*.md。 - 自定义模式:你可以通过项目规则(
rule"..."指令)注册自己的文档,或修改expert/下的档案——一旦锁定模式,不会自动回退。
你会看到什么变化?
- 更准的回答:AI 对项目的架构和约束"心中有数",方案更贴合实际。
- 更少的重复交代:架构、铁律、密钥位置这些事,说一次就永久生效。
- 可审计、可修改:所有档案都是普通 Markdown 文件,放在项目里,随时可以打开看、改、删。
常见问题
Q:我的项目很简单,也需要 E-Flow 吗? 不需要。E-Flow 是为复杂项目设计的(多语言、多模块、外部服务集成等)。简单项目保持零配置即可。
Q:档案文件会占很多上下文吗?
不会。注入上下文的只有薄索引 index.md(很小),详细档案由 AI 按需读取。
Q:我想自己写规则,怎么弄?
直接用项目规则文件(rule"...")注册你的文档即可,E-Flow 会进入自定义模式。你也可以随时编辑 expert/ 下的档案文件。
Q:改了档案,AI 下次会生效吗? 会。档案文件是每次对话时重新读取的,改动即时生效。