跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

仅适用于 1.0.0 及更高版本。
知识卡片与 Repo Wiki 同步生成,是从代码中提炼的高密度知识单元。它以 Agent 易于直接消费的形式,存储架构文档、代码规约(Spec)和技术栈信息,并在每次 commit 过程中持续追踪代码变更,始终保持知识的实时性与准确性。 知识卡片

使用场景

  • 架构文档驱动的系统理解:Agent 基于预构建的架构文档,无需反复检索代码库,即可快速回答「该模块的整体设计思路是什么?」或「各服务之间的依赖关系如何?」之类的问题。
  • 代码规约(Spec)指导下的开发任务:当需要确保代码风格、接口设计或业务逻辑符合团队规范时,Agent 可直接参照规约知识作出判断,支持以下场景:
    • 新增功能时自动对齐命名规范与接口约定
    • 代码审查时快速核查实现是否符合规约要求
    • 修复漏洞时识别违反规约的潜在风险点
  • 技术栈知识加速技术决策:Agent 结合预置的技术栈信息,在上下文受限或跨语言/框架场景下高效支持以下任务:
    • 评估引入新依赖的兼容性
    • 生成符合当前技术栈风格的代码片段
    • 解答「当前项目使用了哪些框架及版本?」等技术环境类问题

知识卡片类型

  • 架构文档 记录模块的整体设计思路、服务依赖关系和关键决策,帮助 Agent 在无需逐行阅读代码的情况下理解系统全貌。
  • 代码规约(Spec) 沉淀团队的编码标准、命名规范、接口约定和业务逻辑约束,确保 Agent 在生成代码时与团队规范自动对齐。
  • 技术栈 记录项目所用的框架、库及版本信息,帮助 Agent 在引入新依赖或生成代码片段时,做出符合当前技术环境的决策。

知识卡片生成

建议选中主分支及核心开发分支进行生成,以覆盖项目的核心内容。生成过程中,已完成的卡片可实时预览,无需等待全部完成。
生成建议:优先在主分支(main / master)和团队常用的开发分支上生成知识卡片,以确保 Agent 能理解最核心的业务逻辑和代码结构。

共享与多语言知识

支持知识卡片共享,助力团队内的知识更高效流动。 当在本地生成知识卡片时,系统会在代码仓库的专用目录(.qoder/repowiki)中自动保存相关数据。你可以将该目录提交并推送到远程分支。团队成员随后可通过 git pull 拉取生成的知识卡片内容——无需额外配置。 此外,知识卡片支持多语言。你可以在生成时选择首选语言(目前支持 English中文)。系统会根据你的语言选择,为每种选定的语言自动创建独立的子目录(例如 zh/en/)。

计费

生成和更新会正常消耗 Credits,可去用量详情-Credits中查看消耗记录。