产品详细介绍
Dosu 是一款专为 AI 时代打造的文档与知识管理工具,它的核心理念是:代码本身已经包含了大部分真实、最新的知识,而文档应该由代码来驱动。Dosu 通过对代码库进行智能解析和持续跟踪,为团队自动生成、自动更新技术文档,让文档不再落后于代码。
与传统手工维护文档的方式不同,Dosu 将“文档生成”和“知识维护”视为一条类似 CI/CD 的流水线:
- 自动生成新文档(Auto Generate New Docs):基于代码结构、注释、接口定义和变更记录,自动产出初始文档,包括 API 文档、模块说明、数据结构说明等。
- 知识 CI/CD(Knowledge CI/CD):在代码变更时自动检测知识影响范围,触发文档更新流程,避免“代码已改、文档未改”的常见问题。
- AI Agent 上下文层(AI Agent Context Layer):为团队内部或外部的 AI 助手提供统一、结构化的知识上下文,让 AI 回答问题时能直接引用最新的代码与文档信息。
- 自动化辅助(Automatic Assistance):在开发、评审或阅读代码时,自动给出相关文档链接、设计说明和历史变更背景,减少在多个工具之间来回切换。
- 自组织 Wiki(Self-Organizing Wiki):根据代码依赖、团队使用频率和搜索行为,自动整理知识结构,形成不断演化的技术 Wiki,而无需人工频繁搬运和归档。
Dosu 适用于以代码为核心资产的技术团队,包括使用 LangChain、LlamaIndex 等 AI 框架的团队,或基于 Apache Airflow、CNCF 生态、Apollo 等基础设施构建数据与服务平台的团队。通过与现有代码仓库和工具链集成,Dosu 能够在不改变开发习惯的前提下,让文档自然“长”在代码之上。
总体而言,Dosu 解决的是“知识瓶颈”问题:当系统复杂度不断提升、人员流动加剧时,团队往往被缺失或过期的文档拖慢。Dosu 通过自动化和 AI,将文档维护从高成本的人力工作转变为可持续、可追踪的系统能力。
简单使用教程
以下是一个从零开始接入 Dosu 的简明流程示例,帮助你快速理解其基本用法:
-
接入代码仓库
- 在 Dosu 平台创建工作空间。
- 连接你的代码仓库(如 GitHub、GitLab 或自建 Git 服务)。
- 选择需要接入的项目或仓库分支,授权 Dosu 进行只读或必要的访问。
-
首次扫描与文档生成
- 触发首次代码扫描,让 Dosu 分析项目结构、模块依赖、接口定义和注释。
- 扫描完成后,平台会自动生成初始文档,包括:模块概览、API/接口说明、关键数据结构、配置项说明等。
- 在 Web 界面中浏览这些文档,进行必要的补充说明或编辑。
-
配置知识 CI/CD 流程
- 在项目设置中开启“知识 CI/CD”功能,将文档更新与代码变更关联。
- 可选:在 CI 流水线中加入 Dosu 的检查步骤(如在合并请求 / Pull Request 时触发文档影响分析)。
- 设置规则:例如当某些目录或接口发生变更时,自动标记相关文档为“待更新”或自动重生成部分内容。
-
启用 AI Agent 上下文层
- 将 Dosu 生成的知识库作为上下文源,接入你使用的 AI 助手(如内部 ChatBot、代码助手等)。
- 在 AI 工具中配置 Dosu 提供的 API 或插件,使其在回答问题时优先引用最新的代码与文档。
- 测试:向 AI 提问与项目相关的问题,确认其能引用到 Dosu 中的文档内容。
-
使用自组织 Wiki 查找知识
- 通过搜索或导航进入 Dosu 的自组织 Wiki,按模块、服务、数据流等维度浏览知识。
- 在日常开发中,将 Dosu 作为“单一知识入口”,减少在多个文档工具之间跳转。
- 鼓励团队成员在需要时补充高层设计说明、决策记录等,Dosu 会自动将这些内容与代码结构关联。
-
日常维护与优化
- 定期查看“文档健康度”或“知识覆盖率”等指标,识别薄弱区域。
- 根据团队反馈调整自动生成策略,例如:哪些模块需要更详细的说明、哪些内容应由人工主导。
- 随着项目演进,持续利用 Dosu 的自动化能力,让文档与代码保持同步更新。
通过以上步骤,团队可以在较短时间内搭建起一个由代码驱动、自动演进的技术知识体系,让文档真正成为开发效率和协作质量的助推器,而不是额外负担。




