CodeWiki 简介

CodeWiki 是通过 AI 深度分析工蜂项目代码后，智能生成的、结构化提炼的项目关键知识文档，可阅读可检索，帮助你高效地理解项目代码，CodeWiki 支持与代码变更同步更新，解决以前人工编写困难、维护不及时的问题。

CodeWiki有内网版和合作版两个版本，分别对应工蜂内网版和合作版的项目。

• 内网版（支持工蜂内网版项目）：https://codewiki.woa.com/
• 合作版（支持工蜂合作版项目）：https://codewiki.tencent.com/

权限声明

CodeWiki的权限遵从工蜂项目的权限，有工蜂的项目权限者才能访问对应的CodeWiki

CodeWiki 产品组成

CodeWiki 包含「代码摘要」和「项目Wiki」两个部分

代码摘要

概念说明

• 源代码中的结构体、类、函数、方法、常量、变量、接口、枚举等，统称为实体。

• 「代码摘要」是对源代码解析出一个个实体及代码块，再由AI分析提炼出实体的摘要，包含这个实体的概述、参数说明、返回值、使用事例。

使用场景

• 知识库检索：代码实体 和 代码摘要 作为Knot知识库中的代码知识数据，广泛应用于Knot智能体中，支持智能体快速、准确的检索。

• 辅助阅读代码：在工蜂仓库网页上浏览代码 或 IDE上查看代码时，可以一边查看代码一边阅读代码摘要，辅助你理解代码。

项目Wiki

概念说明

• 「项目Wiki」是基于项目中的所有代码实体及摘要，由AI深度理解后提炼的、结构化的项目级关键知识文档，一般包含项目概述、系统架构、核心流程、功能模块等文档，也可以是一份专项文档（比如AI README、领域知识文档）。

使用场景

• 学习新项目：在接触一个新项目时，阅读「项目Wiki」可以帮助你快速了解项目的概况、架构和核心流程，通过CodeWiki助手再进一步学习代码实现细节。

• 专项文档辅助AI理解：在复杂项目中，可能代码规模大而影响检索效果，比如在Knot知识库或IDE代码生成场景，需要定制一份专项文档让AI更了解项目，针对你的提问更能准确找到目标。

联系我们

如果你在使用CodeWiki过程中有任何问题或者想法，欢迎跟产品经理Bennyzeng交流。