用 Showboat 让 AI 智能体生成代码走查文档
有时候,让 AI 编码智能体为你生成一份结构化的代码走查文档会很有用。
可能是你需要快速上手现有代码,可能是忘了自己代码的细节,也可能是整个项目都是 vibe coding 出来的,现在需要搞清楚它到底是怎么工作的。
前沿模型配合合适的执行框架(Harness),就能构建出详细的走查文档,帮你理解代码逻辑。
用 Showboat 和 Present 应用做例子
我最近用 Claude Code 和 Opus 4.6 在 Mac 上 vibe coding 了一个 SwiftUI 幻灯片应用。
当时我在讲 2025 年 11 月到 2026 年 2 月间前沿模型的进展,喜欢在演讲里加点噱头(一个 STAR 时刻——Something They'll Always Remember)。这次我决定,最后的噱头就是揭晓:幻灯片机制本身正是 vibe coding 能做到的例子。
我把代码发布到 GitHub 上,然后发现自己完全不知道它是怎么工作的——整个项目都是靠提示词催生出来的,我根本没留意它写了什么代码。
于是我打开 Claude Code for web 的新实例,指向我的仓库,输入了这样的提示词:
I want you to write a detailed walkthrough of this codebase, explaining how it works.
Use the showboat tool to write the walkthrough. Use showboat note to add Markdown text and showboat exec to run commands and include their output.
Use sed or grep or cat or whatever you need to include snippets of code you are talking about.
Showboat 是我开发的一个工具,用来帮助编码智能体撰写展示其工作的文档。你可以看看 showboat --help 的输出,它的设计就是让模型知道怎么使用这个工具。
showboat note 命令用来往文档里添加 Markdown 文本。showboat exec 命令接受一个 shell 命令,执行它,然后把命令和输出都添加到文档里。
通过告诉它“用 sed、grep、cat 或任何你需要的工具来包含你正在讨论的代码片段”,我确保 Claude Code 不会手动把代码片段复制到文档里,那样可能引入模型幻觉(Hallucination)或错误的风险。
效果非常好。这是 Claude Code 用 Showboat 创建的文档,详细讲解了所有六个 .swift 文件,对代码如何工作给出了清晰、可操作的说明。
光是读这份文档,我就学到了很多 SwiftUI 应用的结构知识,还吸收了一些 Swift 语言的细节。
如果你担心大语言模型会降低你学习新技能的速度,我强烈推荐采用这种模式。即使是一个约 40 分钟 vibe coding 出来的玩具项目,也能变成探索新生态系统、学到新技巧的机会。
觉得有用?分享给更多人