Skip to content

Showcase

xiweicheng edited this page Oct 15, 2026 · 2 revisions

AI Helper 实战:从零搭建开源项目的双语 Wiki

← 返回 Wiki 首页 · 🌐 English

这篇文章不是产品说明书,而是一份真实实战记录。它记录的是:AI Helper 这个开源浏览器插件,是如何亲手完成它自己项目 Wiki 的搭建、双语化、跨平台同步与文档维护的。

从生成 8 页中文文档,到翻译成 8 页英文,再到同步到 Gitee、写自动化脚本、对照最新源码修订配置文档——全程零手写 Markdown,全部由 AI Helper 在浏览器里配合本地 Agent 协作完成。

这不是演示视频,是真实发生过的执行日志。下面按时间线拆解。


一、实战一:从零生成 8 页中文 Wiki

任务:GitHub Wiki 还是空白页,需要基于项目源码写一套完整文档。

AI Helper 做了什么:

  1. 通读项目 —— 读取 docs/zh/DOCUMENTATION.md、agent/README.zh-CN.md、CHANGELOG.md、manifest.json、package.json,并对照 src/ 源码核实;
  2. 提炼素材 —— 整理出 42KB 原始素材(616 行,按 12 章组织),作为文档底稿;
  3. 生成文档 —— 产出 8 页中文 Wiki:首页 / 快速开始 / 核心功能 / 内建工具 / 代理服务 / 配置 / 架构 / 常见问题,共 1834 行;
  4. 发布上线 —— 在网页端创建首页启用 Wiki 仓库,git clone 后直接写文件推送。

亮点:过程中发现原文档漏收了 3 个工具(debug_page、handle_dialog、knowledge_*),主动补进文档——AI 不是简单搬运,而是会"发现文档和代码不一致"。

二、实战二:双语化,再生成 8 页英文版

任务:给 Wiki 加英文版,且不能和中文版冲突。

AI Helper 做了什么:

  1. 方案对比 —— 评估三种排版(独立 slug / 单页双语折叠 / 换名让位),选择互不干扰的独立 slug 方案(Home-EN、Quick-Start-EN…);
  2. 生成英文页 —— 产出 8 页 -EN 英文文档,每页顶部带语言切换横幅;
  3. 同步导航 —— 侧边栏改为双语导航,交叉链接全部指向对应语言版本。

三、实战三:跨平台同步到 Gitee

任务:把 GitHub Wiki 同步到 Gitee Wiki。

AI Helper 做了什么:

  1. 推送同步 —— 通过 git@gitee.com:xiweicheng/ai-helper.wiki.git 推送,16 页全部同步(8 中文 + 8 英文);
  2. 实测差异 —— 发现 Gitee 与 GitHub 的 3 个差异并逐一处理:_Sidebar/_Footer 不被 Gitee 识别(当普通页显示,已删除)、侧边栏按字母排序无分组、带锚点 URL 不自动滚动(点页内链接才滚动)。

四、实战四:写自动化同步脚本 + npm 入口

任务:把"同步到 Gitee"从手动操作变成一条命令。

AI Helper 做了什么:

  1. 写脚本 —— sync-wiki-to-gitee.sh:mktemp 自动建临时目录 → 双端克隆 → rsync --delete 同步(排除 _Sidebar/_Footer)→ 有变化才 commit+push → trap 自动清理临时目录;
  2. 修 macOS 坑 —— 修掉 bash 3.2.57 的 bug:set -u 下 $VAR 紧跟全角括号会把首字节并入变量名(WORKDIR� unbound variable),统一改为 ${VAR} 花括号规避;
  3. 加 npm 入口 —— 在 package.json 增加 npm run sync:wiki,一条命令完成同步。

五、实战五:对照最新源码重写配置文档

任务:用户质疑 Configuration 页"写得不全",要求对照最新代码核对。

AI Helper 做了什么:

  1. 逐页核对 —— 打开 options.html + src/options/*.js + constants.js + side_panel.html 逐一比对;
  2. 发现结构错误 —— 文档写 9 个标签页,实际只有 7 个:图片识别/流式输出/对话不是独立页,知识库 RAG 整页漏掉;
  3. 修正配置范围 —— ReAct 循环 10–1000、API 超时 1–10min、循环超时 1–120min、工具超时 1–30min,并标注"澄清超时/重试/预筛选已移除 UI";
  4. 修正快捷键表 —— Alt+Ctrl/Cmd+↑↓ 回顶/底(而非旧文档的 Alt+Shift),补齐 6 个快捷键;
  5. 中英同步 —— 两个版本同时重写,浏览器逐页验证渲染与跳转。

六、这些能力背后,是 AI Helper 的哪些功能

实战环节 用到的 AI Helper 能力
通读源码、提炼素材 网页内容提取 + 本地 Agent 文件读取
生成 / 翻译文档 长上下文对话 + 多会话管理
逐页浏览器验证 页面操控:打开标签页、点击、滚动、截图分析
git 推送 / 克隆 / 写脚本 本地 Agent 终端命令(三级安全策略)
发现文档与代码不一致 工具预筛选 + 三级反思质量保障
写自动化脚本 代码生成 + 文件读写 + 命令执行

七、结语

这个 Wiki 本身就是 AI Helper 的作品。

如果你也想让 AI 不只是"聊得好",而是真的"干得了活"——帮你写文档、填表单、管文件、跑命令、维护开源项目,欢迎试试:

相关:本页英文版 Showcase-EN · 返回 Wiki 首页

Clone this wiki locally