快速开始
项目与工作区模型
MindMux 围绕一个本地项目根目录来组织。代码层面有时会把它实现成工作区(workspace),但面向用户时,更准确的概念是项目(project):一个承载知识、会话、任务和外部输入的持久工作单元。
两层存储结构
从宏观上看,一个项目包含两个彼此分离的层级:
brain/:保存可持久、可审查的项目知识- 本地运行状态:保存会话、任务和项目级设置
这种分离是刻意设计出来的。
brain/:持久知识层
brain/ 的目标是跨会话、跨机器、跨运行时持续存在。它应该具备这些特点:
- 人类可读
- 方便 Git 管理
- 容易备份
- 即使脱离应用也容易查看
brain 中通常会包含:
background.md、architecture.md、roadmap.md等 root docspages/:带有生命周期状态的结构化知识页面mindmux.json等元数据
运行状态层
本地运行状态保存的是通常不应该纳入源码控制的应用状态,比如:
- 会话日志和元数据
- 任务状态
- 项目级设置
这样运行期的状态记录就不会和长期项目知识混在一起。
为什么这种拆分重要
MindMux 对什么应该进入长期项目记录有明确偏好。
适合放进 brain/ 的内容包括:
- 稳定的产品上下文
- 架构决策
- 设计理由
- 长期可复用的参考资料
适合作为本地运行状态保存的内容包括:
- 正在进行的会话记录
- 任务执行期事件
- 临时性的运行元数据
项目命名
MindMux 会把一个很小的元数据文件放在 brain/mindmux.json 里,让项目拥有显示名称。这个名称会随 brain 一起移动和保留。
brain 位置的灵活性
默认模式是“项目大脑放在项目内部”。应用也支持覆盖项目大脑根目录等能力,但原则不变:整个工作上下文应该围绕一个稳定的项目大脑来组织。
实践建议
对大多数团队来说,最合适的起步方式是:
- 把
brain/放在仓库内,或者放在项目根目录旁边。 - 让运行状态保持本地化且不纳入版本控制。
- 把项目大脑当成共享项目记忆,而不是随手记事本。
这种布局最符合 MindMux 内部设计,也让整个产品模型更容易理解。