代码仓库知识库生成与更新
读取代码仓库并梳理架构、模块与业务流程,生成带源码引用的可导航文档,并随代码变更增量更新。
功能与用途
适合把陌生或缺少文档的代码仓库整理成团队可持续维护的知识库。输入仓库源码,指定面向内部成员还是公开读者,以及需要的内容深度,即可生成总览、架构图、模块说明、流程图、术语解释和代码修改指南。页面相互链接,并附上实际源码引用,方便新人理解系统和开发者定位修改位置。已有知识库可按上次记录的代码版本识别变化,只更新受影响页面并留下更新记录。使用前需配置 OpenKnowledge MCP,并在项目中安装对应知识库模板包。
适用场景
- 接手陌生代码仓库:将源码整理成架构、模块和关键流程文档,帮助新成员理解系统并找到入口文件。
- 让文档跟上代码改动:对比上次文档对应的提交与当前代码,更新受影响页面并记录本次变更范围。
- 制作公开项目知识库:生成面向外部读者的代码说明,以 GitHub 源码链接支撑内容,排除内部信息。
- 沉淀功能修改指南:围绕具体开发任务整理修改位置、操作步骤和注意事项,连接相关模块与概念页面。
适用人群
- 接手存量项目的开发者
- 维护项目文档的技术负责人
- 负责新人入职培训的研发团队
- 维护公开技术文档的开源项目维护者
使用步骤
- 打开代码仓库,确认已配置服务并安装知识库模板包。
- 指定内部或公开读者,以及概览、标准或详尽深度。
- 要求生成知识库,或根据已有版本记录刷新文档。
- 查看总览、架构图、源码引用与页面导航。
- 代码变更后再次刷新,检查更新页面和日志。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
How to work in a Codebase Wiki project (the `codebase-wiki` starter pack): an agent-authored, source-grounded wiki of the surrounding codebase. Read when the project has a `wiki/` knowledge base with `architecture/`, `modules/`, `flows/`, `concepts/`, and `guides/` sections plus `wiki/OVERVIEW.md`, or when asked to generate or refresh a wiki of this codebase. Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and bundles the full generate/refresh procedure in `references/`. Complements the platform `open-knowledge` skill; does not replace it.
使用前准备
- 使用已配置 OpenKnowledge MCP 服务的智能体环境。
- 在项目中通过 ok seed --pack codebase-wiki 安装知识库模板包。
- 提供可读取的仓库源码和 Git 提交记录。
- 生成或更新前需能读取配套的 open-knowledge 技能及生成更新流程文件。