目录地图
这页是 Seed 的目录速查。它帮助你判断资料应该放在哪里,也帮助 AI 在任务开始前少读无关内容。
根目录
| 路径 | 用途 | 是否适合公开 |
|---|---|---|
README.md | 当前项目入口和启动说明。 | 是,注意不要写私密信息。 |
MAWFLOW_SEED.md | Seed 的公共说明入口。 | 是。 |
TEMPLATE_OVERVIEW.md | Seed 结构和维护说明。 | 是,发布前需复核公开口径。 |
PROJECT_COMMANDS.md | 人类可用的项目指令和工作流速查。 | 可公开,需避免项目私密命令。 |
package.json | 根命令面板和脚本说明。 | 是,真实密钥不要写入脚本。 |
主要目录
| 路径 | 放什么 | 使用建议 |
|---|---|---|
code/ | 业务源码和业务运行配置示例。 | AI 修改前先定位 app_key 和模块。 |
.maw/ | 项目协议、组件、模块、能力、环境、发布、边界。 | 机器可读事实,真实密钥不进入公共文件。 |
docs/ | 需求、设计、模块档案、能力说明、验收和交付文档。 | 人和 AI 共享的事实层。 |
prompts/ | 一次性提示词、任务包、外部分析草稿。 | 只在任务明确命中时读取。 |
ops/ | 检查、配置读取、测试计划、打包和同步脚本。 | 执行前先看说明和风险。 |
release/ | 发布覆盖文件和规则。 | 不放构建产物、日志或裸密钥。 |
.local/ | 本机差异、私有覆盖、原始资料和一次性记录。 | 真实内容不提交,只提交 README/example。 |
artifacts/ | 执行、发布、同步和交付过程记录。 | 默认不作为长期事实,收口可引用摘要。 |
reports/ | 审计、巡检、日报周报和复盘报告。 | 公开前需要脱敏。 |
tests/ | 协议、脚本或项目级测试。 | 跟随任务需要运行。 |
文档目录建议
| 路径 | 用途 |
|---|---|
docs/modules/ | 模块档案和 changelog。 |
docs/technical-map/ | 技术地图说明。 |
docs/capabilities/ | 可复用能力说明。 |
docs/project-signals/ | 项目信号说明。 |
docs/ai-coding/ | AI Coding 规则、模块档案规则和编码约定。 |
docs/ai-instructions/ | 内置指令、术语、经验、学习循环。 |
docs/acceptance/ | 验收记录。 |
docs/delivery/ | 交付资料和事实稿。 |
docs/planning/ | 计划、待办、路线图和任务拆解。 |
放置规则
- 业务代码进
code/。 - 稳定项目事实进
.maw/或docs/。 - 可执行检查进
ops/。 - 一次性任务入口进
prompts/。 - 本机私有资料进
.local/。 - 公开前证据进
reports/或脱敏后的docs/。
下一步
阅读 配置文件,了解 .maw 常见文件如何分工。
