Google Code Wiki 平台指南

一、平台介绍与定位

1. 核心定义: Google Code Wiki (codewiki.google) 是谷歌推出的 AI 驱动代码文档生成 与 代码库理解 专用平台。
2. 核心价值: 解决了 “代码阅读”作为开发效率最大瓶颈 的问题，旨在替代传统静态/易过期的 README 文件。
3. 主要产出: 为整个 GitHub 仓库自动生成并维护动态的、结构化的文档系统。

二、核心功能特性

1. 自动化动态文档:

• 自动解析代码库的架构、模块、API 和类定义；
• 当发生 Commit/PR 合并 等更新时，文档会自动重新生成并保持实时同步；

1. 智能超链接跳转:

• 文档中出现的任何概念、函数或类的描述均直接附带原代码文件与具体行数的跳转链接；

1. 架构图表自动生成:

• 自动绘制架构图（Architecture Diagram）、序列图（Sequence Diagram）及类图，图表会随代码更新自动重绘；

1. Gemini 驱动的代码对话:

• 基于当前仓库的全量文档作为知识库提供实时 AI Q&A；
• 回答中准确附带关键位置的 代码行级引用；

1. AI 音视频概览:

• 结合类似 NotebookLM 的技术，自动生成代码库的高级结构与架构流转的音视频导读。

三、适用人群与场景

1. 开源项目贡献者 / 新入职员工: 快速理解陌生代码库，将 Onboarding（入职引导）成本降至最低；
2. 资深开发者 / 系统架构师: 在几分钟内理清大型或复杂项目的模块划分与底层技术架构；
3. 代码审查者 (Reviewer) / 维护者: 快速核对 PR 修改的影响范围，免除手动维护文档的繁重负担。

四、免费与付费现状

1. 当前服务状态:

• **完全免费（Public Preview）**阶段；公共仓库开放使用，支持直接查询或提交 GitHub 公开仓库进行索引生成；

1. 私有/企业级支持计划:

• Google 正在开发 Gemini CLI extension，用于在本地/企业私有环境运行 Code Wiki；目前私有库功能处于 Waitlist 申请阶段；

1. 官方入口及定价页面链接:

• 平台主页：codewiki.google；
• 官方更新与公告页面：Google Developers Blog。

五、使用指南

1. 直接网址拼接（最快捷）:

• 在浏览器地址栏输入格式为 codewiki.google/github.com/<owner>/<repo>；
• 例如查询 React 仓库可输入：codewiki.google/github.com/facebook/react；

1. 搜索栏查询模式:

• 访问 codewiki.google，直接在输入框粘贴公开 GitHub 仓库链接或搜索项目名称即可生成文档；

1. 互动与提问操作:

• 生成文档后，使用右侧/下方的 Gemini 提问框（如询问“解释这个项目的鉴权流程”、“数据库模块由哪些文件处理”）；
• 点击生成的超链接即可查看对应的源码。

六、注意事项与风险提示

1. 私有仓库支持限制:

• Web 版目前仅支持 GitHub 公开仓库 (Public)，暂不支持直接挂载私有库查询，需等待 Gemini CLI extension 发布以解决本地/企业环境需求；

1. AI 幻觉风险验证:

• 文档基于结构化代码解析生成，复杂逻辑可能存在推断偏差，务必点击文档中的超链接核对关键业务逻辑与实现细节；

1. 超大仓库索引延迟:

• 对于极其庞大的 Monorepo（单体仓库），首次生成或重新索引可能需要一定处理时间请耐心等待。