定制「AI Wiki」生成规则

使用场景

AI Wiki 默认按通用的 Prompt 要求来生成，Wiki 的主题、目录大纲主要依赖大模型对代码摘要的理解，各项目的整体结构可能会有相似性。

如果你希望自定义 Wiki 的主题内容，或者希望自定义 Wiki 的目录大纲，可以通过「定制AI Wiki」来实现个性化的 Wiki。

Rules 类型

「定制AI Wiki」支持两种类型：总体要求 和 主题大纲

• 总体要求：提供项目的背景上下文，帮助 AI 更好地理解您的仓库；并明确 Wiki 的使用场景 和 对生成的内容要求，例如：

  • Wiki 适用于什么角色在什么场景使用
  • 希望 Wiki 包含哪些主题内容
  • 重点分析指定的代码目录

• 主题大纲：用于指引 Wiki 按照什么样的目录大纲来组织，将会影响 Wiki 左侧的目录结构。

使用方法

1. 入口

项目Wiki 页面右上方「更多设置」-「定制Wiki：项目级 或 多模块」-「定制AI Wiki」

2. 编辑Rule

• 你可以根据业务需要，自定义总体要求 和 主题大纲的任意一个或两个
• 当前显示最近更新的Rule内容（如果是首次编辑，则显示系统默认的Rule）
• 编辑后保存即可，将在下次生成Wiki时生效

定制「代码摘要」生成规则

概念说明

• 源代码中的 结构体、类、函数、方法、常量、变量、接口、枚举等，统称为实体。
• 「代码摘要」是对源代码解析出一个个实体及代码块，再由AI分析提炼出实体的摘要，包含这个实体的概述、参数说明、返回值、使用事例。

使用场景

除了在工蜂网页上可以边浏览代码边阅读代码摘要，代码实体&摘要作为Knot知识库的代码数据源，广泛地应用于Knot智能体中，支持智能体高效检索。

!!#ff3333 如果你希望定制实体对应的代码摘要内容，进一步提升智能体检索效果，那么可以通过「定制代码摘要」来实现。!!

使用指引

入口

「设置」-「定制Wiki：整个项目」-「定制代码摘要」

说明：代码摘要规则应用于项目下所有的代码路径

添加语言

• 代码实体按语言来区分，摘要是对每一类代码实体来生成
• 已支持语言：Java、C/C++、Go、Python、Js/Ts、Html/Vue、Kotlin、Lua、Objective C、PHP、C#、Shell、SQL、Proto、Rust、scala、Swift

编辑Prompt

• 系统给出每个语言的初始Prompt，你可以针对每一类代码实体定制代码摘要的生成规则
• 红色框是对每一类代码实体的定制要求，蓝色框是对该语言总体的要求

快速验证

• 为了查看定制的Prompt的效果，可选择仓库中5个以内文件，进行快速验证
• 验证过程可以查看流式输出、实体列表和实体的摘要内容
• 可以点击左侧按钮展开编辑区查看Prompt
• 验证完成或手工终止后，可保存Prompt为一个新版本，新版本将在下次wiki任务中生效