三个层级,一条清楚的阅读路径。
先理解系统全貌,再按需进入模块和节点。读者只需要看到真正有助于理解产品或实现的细节。
这里展示的是同一张地图,不是三个案例。选择一个层级,看看读者深入阅读时会多理解什么。
先看产品故事,以及一条贯穿整个系统的完整路径。
读者获得:系统目标、主要职责和核心旅程,不必先理解实现细节。
只展开一个有意义的边界,其余仓库仍保持简洁。
读者获得:模块职责、判断、接口、失败路径和结果,并使用适合其角色的语言。
只有当实现或证据确实重要时,才进入单个节点。
这个节点把一条产品规则变成明确的系统判断。
- 输入
- 访问令牌
- 输出
- 当前用户或访问错误
- 源码
backend/app/api/deps.py:25–46- Prompt
- 代码中存在真实 Prompt 时在这里展示
读者获得:职责、输入、输出、准确源码证据,以及相关场景中的真实 Prompt 摘录。
直接告诉 Agent 你想理解什么。
产品和技术不是两个僵硬模板。Agent 会把自然语言变成实际的模块边界、颗粒度、名称、Prompt、关系与折叠层级。
给产品经理看。重点解释每个模块做什么、用户能看到什么,以及真实 Prompt;框架和数据库管线尽量合并。
我会优先展示能力和用户旅程,合并普通基础设施,并把源码证据保留在每个节点的详情中。
支付失败恢复再细一点。展示两个 Prompt 分别怎样改变最后回复,但普通 API 接线不用展开。
我会拆分该模块、增加 Prompt 影响关系、保留证据,重新校验完整路径,并只在交付成功后替换 HTML。
真实代码库,不同读者,完整地图。
这些不是装饰性的效果图。每张预览都能打开一份由固定公开 commit 生成的独立 HTML,里面包含系统总览、模块视图、节点证据和可继续修改的 JSON IR。
先索引,再解释。
先安装 Codebase Memory 代码智能工具,再把本 Skill 复制到本地 skills 目录。前者负责完整结构索引,已有 Agent 负责按照读者目标整理内容。
git clone https://github.com/farmerzh47/codebase-system-map.git
cd codebase-system-map
$skillPath = Join-Path $env:USERPROFILE ".codex\skills\codebase-system-map"
New-Item -ItemType Directory -Force $skillPath | Out-Null
Copy-Item ".\codebase-system-map\*" $skillPath -Recurse -Forcegit clone https://github.com/farmerzh47/codebase-system-map.git
cd codebase-system-map
mkdir -p "$HOME/.codex/skills/codebase-system-map"
cp -R codebase-system-map/. "$HOME/.codex/skills/codebase-system-map/"结构尽量小,依赖必须说清楚。
Codebase Memory 提供详细的仓库智能信息;Node.js 校验并交付地图;Viz.js、Graphviz 和 Expat 在独立 HTML 内渲染图形。
Codebase Memory
参考代码智能工具,负责仓库索引、架构分析、搜索、路径追踪和有范围限制的源码读取。
Viz.js 3.29.0
每份生成文档内嵌的 JavaScript 封装和 WebAssembly 图形渲染器。
Graphviz
编译进 Viz.js WebAssembly 的 DOT 布局引擎,负责生成图形的 SVG 几何结构。
Expat
由 Viz.js 对象代码间接包含的 XML 解析器。
Codebase Memory 单独安装,通过它的 Agent Skill 或 MCP 接口使用。网站使用原生 HTML、CSS 和 JavaScript 实现。查看完整第三方说明和许可证文本。

