FSoft-AI4Code/CodeWiki
[ACL 2026] Open-source framework for holistic, structured repository-level documentation across multilingual codebases
解决的问题
大型代码库通常难以导航和理解,因为文档往往会过时或根本没有编写。本项目可为任意规模的仓库自动创建全面、分层的文档,确保文档与实际代码结构保持同步。
工作原理
CodeWiki 通过分析仓库构建依赖图,并将其聚类为分层模块树。它利用 AI 代理为每个模块生成文档,包括概述和 Mermaid 图表。它支持增量更新,这意味着它仅为受近期代码更改影响的模块重新生成文档,从而节省时间和 API 成本。它可以通过 CLI 使用,也可以通过 MCP 服务器集成到 AI 驱动的 IDE 中。
适用人群
从事大型软件项目开发且需要维护最新架构和功能文档,同时又不想承担手动编写文档负担的开发人员和团队。
亮点
- 支持 13 种编程语言,包括 Python, Java, C++, Rust 和 TypeScript。
- 制品感知:自动记录构建文件、CI 工作流、Dockerfile 和配置模式,并与源代码同步。
- 增量更新:仅针对修改过的组件高效刷新文档。
- 灵活集成:可与各种 LLM 提供商(如 OpenAI, Anthropic 等)配合使用,或直接通过基于订阅的 CLI 工具和 IDE 代理使用。
相关
- 项目
- 项目
- 项目
- 项目