OthmanAdi/codebase-knowledge-builder

# codebase-knowledge-builder 一个用于研究任何代码库并生成结构化知识工件的 Agent Skill。将其放入 Claude Code、Cursor、OpenCode 或任何支持 [agentskills](https://agentskills.io) 规范的 Agent 中，指向一个代码库，即可获得真正有用的文档。 [](https://getskillcheck.com) [](LICENSE) [](https://skills.sh/othmanadi/codebase-knowledge-builder) ## 它的功能 大多数 Agent 会忘记它三个文件前读过的内容。此 Skill 通过遵循四个阶段的过程来解决这个问题： 1. **侦察 (Reconnaissance)** —— 扫描仓库结构，识别技术栈，映射模块边界 2. **深入研究** —— 追踪每个子系统的正常路径、错误路径和边缘情况 3. **工件撰写** —— 填写结构化模板，涵盖架构、关键函数、陷阱和 Mermaid 图表 4. **交付** —— 交回独立的 Markdown 工件，任何开发者（或 Agent）都可以零背景阅读 输出是一组知识工件。每个工件涵盖一个子系统并独立存在。无需先验上下文。 ## 何时使用 - 入职接触不熟悉的代码库 - 为没有文档的仓库生成文档 - 准备知识文件，以便其他 Agent 无需重新阅读所有内容即可处理项目 - 深入研究特定子系统（auth、database layer、API routing 等） ## 安装 ``` npx skills add OthmanAdi/codebase-knowledge-builder --skill codebase-knowledge-builder -g ``` 适用于 Claude Code、Cursor、Codex、Gemini CLI 以及 40 多种支持 [Agent Skills](https://agentskills.io) 规范的 Agent。 **手动安装：** 将 `skills/codebase-knowledge-builder/` 复制到您 Agent 的 skills 文件夹中。 ## 内部结构 ``` skills/codebase-knowledge-builder/ SKILL.md # Skill definition and workflow references/ recon-checklist.md # Phase 1 checklist deep-dive-methodology.md # File reading and tracing strategies templates/ knowledge_artifact.md # Output template for each subsystem ``` SKILL.md 保持精简（约 80 行）。详细的方法论位于 `references/` 中，仅在需要时加载。`templates/` 中的模板定义了 Skill 生成的每个知识工件的确切结构。 ## 输出示例 在 Node.js API 上运行 Skill 后，每个工件包括： - 架构概述及设计模式识别 - 关键组件表（组件、文件路径、职责） - 分步的数据流和控制流 - 关键函数表（含参数和返回值） - 配置和环境变量映射 - 陷阱和隐患（竞态条件、缓存怪癖、历史修复） - 用于添加新功能的扩展点 - 用于可视化流程的 Mermaid 图表 ## 底层工作原理 该 Skill 使用渐进式披露。当 Agent 触发它时，只有 SKILL.md 主体加载到上下文中（约 600 个单词）。参考资料和模板在每个阶段按需加载。这保持了上下文窗口的清洁，以便研究实际的代码库文件。 研究过程中会保存临时文件（`recon_findings.md`、逐文件笔记），这样 Agent 在阅读更多文件时不会丢失发现内容。最后的质量检查表会在交付前捕获不完整的部分、缺失的图表和占位符文本。 ## 贡献 有关提交 Issue 和 Pull Request 的指南，请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。 ## 许可证 [MIT](LICENSE)

标签：AgentSkill, AI Agent 技能, Claude Code, Cursor, LLM 上下文管理, Markdown, Mermaid 图表, 代码地图, 代码审查辅助, 代码库分析, 代码理解, 大语言模型工具, 威胁情报, 开发者工具, 技术文档, 文档结构分析, 架构分析, 浏览器安全, 知识库构建, 知识提取, 自动化文档生成, 软件开发, 防御加固, 项目入职