Skip to main content
博客

Repo Wiki :让隐性知识自动浮现

支持repo wiki 共享和导出

返回

Repo Wiki 能为你做什么?

Repo Wiki 能基于代码自动为你的项目生成结构化的文档知识库,涵盖项目架构、引用关系图谱、技术文档等内容,并持续跟踪代码与文档的变更。让隐藏在代码中的经验性知识,变为团队可共享的显性知识,把经验沉淀为可复用的工程资产。在使用 Qoder 开发过程中 Repo Wiki 可以帮助你:提升与智能体的协作效率结构化且完整的工程知识让智能体更深入理解上下文,提供更准确、详尽的回答,显著提升研发效率。快速理解陌生项目通过查阅清晰完整的工程文档,让你快速掌握项目结构与实现细节,轻松上手开发,降低协作与维护成本。

Repo Wiki 是如何生成的?

image.png
Repo Wiki 采用多 Agent 架构,分阶段逐步生成工程知识。Repo Wiki会自动为代码库建立索引,从而通过工具为 Agent 提供强大的工程感知能力。多 Agent 系统会对代码库进行分析建模,规划文档结构,平衡知识深度和阅读效率,将工程知识合理刻画到各类文档中。

Repo Wiki 是如何维护和共享的?

image.png
知识共享为了让知识更好地在团队中流转,我们提供了 Wiki 共享能力。当你在本地生成 Wiki 时,系统会自动在代码库中创建一个专属目录(.qoder/repowiki)。只需将该目录推送至远程分支,即可将生成的文档轻松共享给团队成员,实现协作共建。内容维护及导出 为确保 Wiki 与代码始终保持一致,我们内置了自动检测机制。当发现代码变更导致文档滞后时,系统会及时提醒你更新 Wiki。同时,为了支持灵活的自定义维护,你也可以直接修改 .qoder/repowiki 目录下的内容,修改后可同步 Wiki, 实现自行维护的诉求。

最佳实践

  • 智能对话场景
查询代码库信息时,智能体会自动查阅 Repo Wiki 相关知识,结合上下文信息,为开发者提供准确的代码解释、相关的技术文档、完整的实现细节等,智能体可以基于 Repo Wiki 的知识库,快速且准确地回答开发者的各类问题。在新增功能或修复缺陷时,智能体会自动查阅 Repo Wiki 的顶层架构设计,结合实时的工程感知信息,提供符合项目架构的解决方案,这样可以确保新增的代码与现有系统保持一致性,同时提高开发效率。
  • 代码库阅读场景
开发者可以在日常开发中通过 Repo Wiki 快速了解项目的整体架构、模块依赖关系和技术实现细节。它提供了结构化的文档知识库,如项目架构说明、模块间引用关系图谱、详细的技术文档等,这些信息可以帮助开发者更快地理解陌生的代码库,提高开发效率。