你的项目中有什么
Floorplan 只会写入你项目中的两个位置：floorplan/ 文件夹，以及（在 Claude Code 中）CLAUDE.local.md 里的一小段内容。两者都不会提交到 git，你项目中的其他任何内容都不会被改动。
floorplan/ 文件夹¶
| 文件 | 是什么 | 要编辑吗？ |
|---|---|---|
index.html |
地图：一个自包含页面 | 否。每次都会重建 |
graph.json |
地图显示的所有内容，以数据形式呈现 | 否。每次都会重建 |
architecture.json |
应用各部分、外部服务、额外连接、流程和导览 | 是 |
descriptions/*.json |
每个文件和端点的名称与描述，每个部分一个文件 | 是 |
plan.json |
仅蓝图：计划中的文件、端点和界面，每个端点可由谁使用、技术栈、假设和未决问题。名称和描述放在这里，而不是 descriptions/ |
是 |
recent-work.json |
刚刚完成的工作及其原因。每次更新时替换 | 很少。由 AI 写入 |
custom-flows.json |
从地图请求的流程 | 仅在删除某个流程时 |
serve.mjs |
在本地提供地图服务，并通过 Claude Code CLI 或 Codex 回答问题 | 否 |
query.mjs |
从命令行在地图中查找内容；Claude 和 Codex 也会使用它 | 否 |
artifact.html |
用于在 Claude 应用中打开的副本，仅当你要求生成时 | 否 |
<project>-map.html |
用于分享的导出副本，仅当你从 Claude 或 Codex 导出时（地图的 Export 按钮会改为下载它） | 否 |
.cache/ |
扫描结果、描述工作表、上次更新的改动、正在运行的服务器地址；对于蓝图，还有 Undo 可回退的最后 20 个计划版本 | 否。可以安全删除，不过删除后 Undo 就没有可回退的内容了 |
.gitignore |
让整个文件夹不被 git 跟踪 | 否 |
编辑名称和结构¶
你对 architecture.json 和 descriptions/ 的编辑会在每次更新时保留。你可以：
- 重命名某个部分，或改写描述；
- 通过更改
paths模式在部分之间移动文件； - 添加扫描漏掉的连接；
- 在文件上固定一条备注；
- 添加或更改流程和导览。
或者直接告诉 Claude 或 Codex（“把 floorplan 上的 ‘Main server’ 重命名为 ‘Shop API’”）。
蓝图以相同方式编辑，通过 plan.json 和 architecture.json，或在地图上使用 Ask 栏的 Change 开关。计划的格式见 blueprint.md。
完整格式见 skills/floorplan/references/schema.md，名称和描述的样式指南见 writing-descriptions.md。
CLAUDE.local.md¶
在 Claude Code 中，Floorplan 会在这里添加一小段带标记的内容，告诉你的项目中未来的 Claude Code 会话：地图存在，以及如何在地图中查找内容。CLAUDE.local.md 是 Claude Code 用来保存个人项目笔记的文件，会在每次会话开始时像 CLAUDE.md 一样被加载。Floorplan：
- 如果你没有该文件，就创建它；
- 只重写属于它自己的部分，即
<!-- floorplan:start -->和<!-- floorplan:end -->之间的内容； - 将该文件添加到你的克隆仓库的私有忽略列表
.git/info/exclude中。
要关闭它，请在 CLAUDE.local.md 中的任意位置放置 <!-- floorplan:off -->。
蓝图不会添加任何部分，因为还没有可查找的代码。一旦地图切换到真实代码，就会添加该部分。
在 Codex 中，这个文件不会被改动。Codex 没有个人未提交的笔记文件（AGENTS.md 是与团队共享的），因此 Floorplan 不会在那里添加笔记。
保持不被 git 跟踪¶
floorplan/包含自己的.gitignore，会忽略该文件夹中的所有内容，包括它自己。你的.gitignore不会被改动，该文件夹也绝不会出现在git status中。CLAUDE.local.md被列在.git/info/exclude中，这是每个克隆仓库私有的忽略列表，永远不会被提交。如果你的项目已经忽略了它，则不会添加任何内容。
地图对每个克隆仓库来说都是私有的。安装了 Floorplan 的队友会生成他们自己的地图。
如果你之前提交过 floorplan/ 文件夹，忽略它并不会取消跟踪那些文件。构建过程会告诉你取消跟踪的命令，该命令会保留磁盘上的文件：
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 floorplan/floorplan