跳转到主要内容

Knowledge 101

Knowledge 是在代码库层面(而非任务层面)向 Devin 提供上下文信息的最佳方式,能帮助 Devin 更好地在你的代码库中工作。适合写入 Devin Knowledge 的信息包括:代码规范实践、部署流程、PR 命名规范、测试流程、如何与专有工具交互等。 关于 Knowledge,有几件需要注意的事:
  • Devin 会基于已存在的 README、文件结构以及已连接代码库的内容自动生成仓库级 Knowledge(repo knowledge)。请注意,如果你没有给 Devin 访问该仓库的权限,它就不会生成任何关联的 Knowledge。
  • Knowledge 会根据你设置的 Trigger(触发条件)来检索。Trigger 越具体(例如适用的文件、仓库或任务类型),检索效果就越好。你可以在这里找到更多细节。
  • Devin 会在会话中告诉你它使用了哪些 Knowledge,你可以在会话聊天中的“Accessed Knowledge”下方查看。
  • Devin 会基于你代码库中的一些特殊文件(包括 .rules.mdc.cursorrules.windsurf)自动获取并更新 Knowledge。请注意,Devin 不会自动获取更通用的文件类型,比如 .md

Knowledge 启用最佳实践

在前期花一点时间让 Devin 熟悉情况非常有帮助。就像新员工入职一样,向 Devin 提供与你的代码库和工程团队工作流相关的背景信息,将极大提升 Devin 的工作效果。以下是在首次设置 Devin 的 Knowledge 时推荐执行的一些步骤:
  1. 检查所有自动生成的 Knowledge,并核实其 (a) 完整性和 (b) 准确性。
  2. 如果你希望 Devin 在处理任何会话时都能检索到这条 Knowledge 笔记,请确保将其固定到所有代码仓库。否则,如果信息只与特定场景相关,你可以只将其固定到某个特定仓库。如果 Knowledge 没有被固定,它只会在被触发时使用,因此请确保你的触发描述(Trigger Description)足够清晰。
  3. 如果你的代码库中还没有集中管理的专用文档文件,我们强烈建议你创建一个,并使用专用的文件扩展名。
访问 Knowledge 产品指南 了解更多详情。