Whiteboard核心工作流全解从代码分支到完整设计画布的4步评审流程【免费下载链接】whiteboardopen-source canvas for thoughtful software design项目地址: https://gitcode.com/gh_mirrors/whiteboard36/whiteboardWhiteboard 是一个开源的本地设计画布工具an open-source canvas for thoughtful software design让人类与 AI 编码智能体在同一块画布上协作评审代码。它不修改你的代码而是让智能体把一次分支变更画出来语义化的 What/Why 说明、时序图、调用栈对比全部可点击跳转到真实代码行。下面用4 个步骤带你从一条 Git 分支走到一张完整的设计评审画布。1️⃣ 认识 Whiteboard它到底在评审什么传统 Code Review 看的是改了什么行Whiteboard 回答的是三个更本质的问题Why为什么做这个变更Design方案在组件、数据与控制流层面是怎么运作的Implementation代码如何一步步兑现这个设计它有三个核心卖点详见 README.md特性说明️ 图即代码点击时序图、ER 图、智能体 Trace 引文直接跳到对应源码自带 VS Code 级的跳转与 LSP 支持 语义 Diff用 Rust 编写的 AST 感知 Diff 查看器大函数自动折叠为伪代码测试和文档变更默认收起 决策日志智能体可以查询并链接自己的执行 Trace让你看清它自主做了哪些决策 整个流程跑在你本地的代码检出上MIT 许可、可自托管。2️⃣ 第一步安装 Desktop并连接你的编码智能体Whiteboard 的主安装路径是Whiteboard Desktop安装时会同时装上whiteboardCLI下载并打开 Whiteboard Desktop桌面应用会自动检测你已安装的智能体Claude Code、Codex、Cursor、Pi 等并提供一键安装 CLI 与通过MCP连接的选项。想手动连接任意智能体只需一条命令支持claude、codex、cursor、pi或allwhiteboard connect agent该命令会打印出对应智能体的 MCP 注册步骤官方说明见 onboarding.md。连接成功后智能体就多了一块画布 SDK——它不再只能输出 Markdown 文字而是能调用 Whiteboard 的 MCP 工具往画布上画图。3️⃣ 第二步一句话触发评审智能体开始动笔在终端里对智能体说请对比最新的 main 分支帮我 review 当前分支并在 Whiteboard 中打开结果。随后智能体会按一套严谨的写作流程执行定义在 instructions/authoring.md注册仓库并解析出固定的 base/head 提交不可变 pin保证画布引用的代码永不漂移创建画布目标可以是某个 PR、一组提交或直接对比工作区——连未提交的修改也能评审读取 diff先落笔 What/Why 段落再逐节推进全程增量书写——你能在画布上实时看到它每几秒画出一块内容。你可以直接观察画布的动笔过程就像看同事在白板前边想边画。4️⃣ 第三步理解画布上的四类核心组件评审画布由 12 种积木块组成但日常最常用的是下面这几类 选一张最贴切的图智能体会根据变更的形状挑选图表见 authoring.md时序图sequence参与者随时间交互、谁调用谁、异步交接流程图flow diagram重点在分支、重试或状态转移数据库视图database lens数据模型变更与读写方代码窥视code peek新增/变更的接口契约直接展示关键类型。 新旧调用路径对比call_stack_diff组件会把用户流程的旧路径与新路径并排画出从入口按钮点击、CLI 命令开始包含沿途未变更的节点——一眼看清行为差异。 文件镜头File LensesDiff 视图里的改动文件会被智能体自动归类为若干镜头测试、文档、生成文件先剔出剩余实现代码按设计中的职责数据模型、API、UI 层分组每个镜头小到一个坐次就能读完。规则定义在 instructions/file-lenses.md。 一切文本都是超链接画布中凡是描述真实代码的短语都会链接为[label](https://link.gitcode.com/i/de41a7e480d337a420230345fbf48a07)形式点击即打开对应源码行——且支持从画布直接跳转代码对应 UI 见 review-app.ts。5️⃣ 第四步在画布上交互让智能体重画评审不是交稿而是持续对话选中不满意的内容一段文字、一个图节点复制直接丢给你的智能体它会按需重画画布画布自带版本历史见 review-api/README.md 的restore {version}命令每个被接受的编辑都是一个可回溯的版本快照想让智能体讲解某段代码的来龙去脉还可以用whiteboard trace blame追溯这行代码是哪个智能体会话、基于什么决策写出来的流程见 instructions/trace-archaeology.md不针对具体变更的即兴讲解可以画在Scratchpad上——一块没有生命周期限制的常驻草稿画布说明见 instructions/scratchpad.md。6️⃣ 完整流程速览把 4 步串起来步骤你做什么Whiteboard 做什么① 安装连接装 Desktop连接智能体自动装 CLI注册 MCP 工具② 触发评审一句话要求review 当前分支注册仓库、pin 提交、创建画布③ 增量生成实时观看画布绘制按 What/Why → Design → Implementation 落笔④ 交互迭代选中内容反馈、点击跳码重画、回溯版本、追溯决策 Trace7️⃣ 实用提示与已知限制 ⚠️选对模型官方经验是配合 GPT-6 Sol、Claude Opus 5.5 这类智力/成本/速度平衡好的模型效果最佳提示词参考README.md 里给出了新 API 变更遥测变更等示例提示词可以直接套用已知限制README.md画布暂不能编辑文件单次评审跨多仓库的体验一般评审分享后产生的更新需要重新分享。写在最后Whiteboard 把代码评审从行级 diff 升级成了设计级叙事从一条分支出发4 个步骤你和智能体共同产出一张能点、能跳、能回溯的交互式设计画布。理解正在成为比生成更稀缺的能力——而 Whiteboard 正是为这件事而生的开源画布。【免费下载链接】whiteboardopen-source canvas for thoughtful software design项目地址: https://gitcode.com/gh_mirrors/whiteboard36/whiteboard创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考