doc-wiki

为AI编程助手构建的、生态感知的代码知识库

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:doc-wiki。
它的用途是:为AI编程助手构建的、生态感知的代码知识库
完整的 Skill 内容见:https://321skill.com/skills/doc-wiki/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“请使用 /doc-wiki:atlas 为当前项目生成知识库。” 它会扫描整个代码库,自动创建包含架构说明、ER图和跨服务依赖关系的维基页面。之后,你可以

对AI说:“查询一下用户认证服务的数据库模型。” AI会通过 /doc-wiki:query 在生成的知识库中找到并引用相关信息。

介绍

doc-wiki 旨在解决AI编程助手(如Claude Code、Cursor等)在面对复杂、历史悠久的真实企业级代码库时,因缺乏上下文而表现不佳的问题。它通过为代码库构建一个动态、生态感知的“维基”知识层,让AI在修改代码前能先阅读和理解整个项目的架构、依赖关系和历史决策。

用户通过在支持的AI编程助手中安装此插件,即可使用一系列 /doc-wiki:* 斜杠命令。核心命令 /doc-wiki:atlas 可以一键为整个代码库生成文档,包括按主题划分的架构页面、从ORM模型自动推导的ER图、跨服务地图(当检测到多个服务时),以及通过 /doc-wiki:query 进行带引用的问答。它通过统一的连接器规划器,支持集成Jira、Confluence、GitHub、GitLab、Notion、AWS、GCP等多种外部服务和数据库,只需配置一次凭证。

该工具非常适合需要维护大型、复杂代码库的团队,尤其是那些拥有多年历史、文档分散、架构复杂(如单体应用或微服务)的企业开发环境。它帮助开发者和他们的AI助手共享同一份不断更新的知识地图,提升协作效率。

与单纯生成静态文档的工具不同,doc-wiki 是专为AI编程助手设计的“可读”知识层,强调生态感知(理解代码间的实际关系)和动态更新。它并非旨在完全自动化地修复更多工单(其基准测试显示在此方面无显著提升),而是专注于生成和提供可导航、可引用的上下文知识,供人类与AI共同使用。

核心特点

核心区别在于:1) 专为AI编程助手(而非人类)阅读而设计,直接集成到Claude Code、Cursor等工具的上下文中;2) 强调“生态感知”,能自动分析代码库内外的依赖关系,生成ER图和跨服务地图,而不仅仅是文件摘要。

注意事项

不适合期望仅靠此工具就能大幅提升AI编程助手在简单、独立任务上完全自主修复工单成功率的场景。

常见问题

doc-wiki 能提高AI自动修复bug的成功率吗?

根据其公开的基准测试,在标准开源仓库上未测量到显著提升。它的核心价值在于为开发者和AI提供共享的、结构化的代码知识库和上下文。

支持哪些AI编程助手?

支持 Claude Code、Codex、Antigravity、OpenCode、Gemini、Cursor、Aider 等,通过读取项目中的标准配置文件(如 CLAUDE.md, AGENTS.md)来工作。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/doc-wiki/raw/index.md 读取 doc-wiki 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。