Wiki
接手一个陌生项目时,最花时间的往往不是写代码,而是搞清楚这个项目是干什么的、主流程怎么跑、模块之间怎么衔接。Wiki 就是让 ZCode 读一遍代码库,把这些整理成一份可以随时查阅的文档。
它的定位是 代码库架构导读,不是产品文档站或使用手册。目录会优先覆盖项目身份、主执行链路、核心模块与子模块、跨端边界、数据与状态流、配置边界、扩展点和风险点,而不是「安装部署」「CI/CD」这类通用栏目。所有结论都带源码位置,可以点击跳回对应文件。
Wiki 完全在本地生成和保存,一个工作区一份。
生成
在工作区文件树顶部、仓库名称右侧点 仓库 Wiki 图标进入,它会占据整个主工作区。还没生成过时,中间是一张状态卡,生成前可以配置四项:
| 选项 | 说明 |
|---|---|
| 语言 | 简体中文或英文,默认跟随界面语言 |
| 模型 | 默认用当前工作区的聊天模型。可以临时换一个,不影响聊天设置 |
| 生成图表 | 默认开启。开启后会在图确实能帮助理解、且有源码依据的地方生成架构图、流程图、时序图或状态图 |
| 重试次数 | 单个页面生成失败时自动重试几次,默认不重试 |
点 生成 Wiki 后,状态条会依次显示 正在分析代码库 → 正在生成目录 → 正在生成页面 → 正在保存 Wiki。
目录一出来就可以开始读:已完成的页面立即可看,还没轮到的在目录里显示等待状态。生成过程中随时可以 停止——已经生成的页面会保留下来,顶部仍然可以重新生成或删除,不会卡在一个不可读也不可继续的半成品上。如果有页面最终没能生成,目录区会显示失败数量。
阅读
界面分两栏:左侧是已打开的项目列表,展开某个项目就能看到它的目录树;右侧是正文。中间的分隔线可以拖动调整宽度,项目列表也可以整个收起;窗口或面板较窄时会自动改成上下堆叠。
顶部显示当前仓库名,下方的 元数据 展开后能看到分支、语言、更新时间、提交 ID 和 Wiki 文件数——用来确认这份 Wiki 对应的是哪个版本的代码。
正文里的每个结论都标注了 源码位置,格式是文件路径加行号区间,点击直接跳到工作区里对应的文件和行。开启图表后生成的 Mermaid 图支持主题适配、缩放和放大预览,单张图渲染失败不会影响正文阅读。
保持更新
Wiki 不需要你记得手动更新。每轮对话结束时,如果这个仓库已经有 Wiki,ZCode 会检查代码是否真的变了——变了才触发刷新,没变直接跳过。
需要主动重来时,顶部工具栏有 重新生成。它默认沿用上次的模型,也可以为这一次临时换一个。
删除 Wiki 只清理本地内容,随时可以重新生成。
它会读哪些文件
生成时 ZCode 只读当前工作区内的文件,并且用的是 Wiki 专用的阅读视图,与其他功能的文件扫描相互独立。以下内容不会进入模型上下文:
.git目录、构建产物、缓存和本地运行态文件;- 根目录
.gitignore忽略的内容; - 文件名中包含 token、secret、credential、password 等字样的疑似密钥文件(
tokenService.ts这类正常源码不受影响); - 指向工作区之外的符号链接。
模型不会拿到一份预先准备好的文件清单,而是自己按目录逐层展开、按需读取,读取范围始终受上面这些规则约束。
限制
- 同一个仓库同时只能跑一个生成任务。
- 同一个仓库只保留一个语言版本。 换语言重新生成会覆盖原来的,中英文不能并存。
- 不支持单页重新生成,也不保留历史版本。