SuperAPI AI 工具集

codebase-mapper

编程与开发

查看项目

更新于 10-15 09:51

技能介绍

用途

Codebase Mapper 用于为不熟悉的代码库生成人类可读的项目指南。其输出是叙事化、教学式的材料,而不是技术转储或面向 AI 的分析。目标读者被设定为“第一天上班的聪明同事”。

主要能力

该工具会生成一套结构化的文档,全部输出到项目根目录的 .codebase-map/ 文件夹中,包括:

  • INDEX.md:入口点,带有可导航的摘要
  • 00-executive-summary.md:面向任何人(非技术)的平实语言摘要
  • 01-overview.md:项目是什么、面向谁
  • 02-features.md:功能能力
  • 03-tech-stack.md:技术和依赖
  • 04-architecture.md:代码如何组织、分层、组件
  • 05-workflows.md:主要用户/系统流程,含图表
  • 06-data-model.md:数据结构、实体、关系
  • 07-getting-started.md:从哪里开始工作、关键文件、开发环境搭建
  • 08-open-questions.md:空白、未知、需要向团队询问的事项
  • 09-project-anatomy.md:配置文件、环境变量、脚本、目录树
  • 10-configuration-guide.md:配置配方、操作、故障排除
  • 11-glossary.md:领域和技术术语表(平实定义)
  • _internal/context-brief.md:第一阶段探索输出(内部参考)
  • _internal/interconnect.md:第一阶段 b 的结构化映射:契约、不变量、领域规则(可选)

使用方式

该工具通过多阶段智能体流水线协作完成:

第一阶段 - 探索:单个 codebase-explorer 智能体读取项目并写入 _internal/context-brief.md,其中以 ## Project Profile(类型、受众、语域)和 ## Why / Context 档案开头。

第一阶段 1.5 - 确认画像:map-codebase 命令会展示推断出的 Project Profile,让用户在写作智能体运行前确认或调整。确认后的画像驱动所有文档的语域和深度。

第一阶段 b - 互连映射:单个 codebase-xray:semantic-interconnect-mapper 智能体读取上下文简报并写入 _internal/interconnect.md(契约、不变量、领域规则、集成热点)。这是可选的:如果失败,流水线以降级模式继续。tech-writer、flow-writer、ops-writer 和 guide-reviewer 会引用此映射,而不是转述代码。

第二阶段 - 写作:六个并行写作智能体,各自读取 context-brief.md:

  • overview-writer:负责 00-executive-summary.md(平实语言)、01-overview.md、02-features.md(思维导图)
  • tech-writer:负责 03-tech-stack.md、04-architecture.md(组件图)
  • flow-writer:负责 05-workflows.md、06-data-model.md(流程图、序列图、ER 图)
  • onboarding-writer:负责 07-getting-started.md、08-open-questions.md
  • ops-writer:负责 09-project-anatomy.md(配置文件、环境变量、脚本、目录树)
  • config-writer:负责 10-configuration-guide.md(配置配方、操作、故障排除)

第三阶段 - 审查:单个 guide-reviewer 智能体读取所有文档,添加交叉引用,修正一致性,对照 Project Profile 检查语域一致性,写入 11-glossary.md,并生成带有按受众阅读路径的 INDEX.md。

此外,该插件还提供独立的文档智能体:

  • documentation-engineer:从代码分析自底向上生成技术文档(API 文档、架构、教程、重构)
  • doc-humanizer:重写现有文档以遵循写作指南

这两个智能体使用与流水线写作者相同的写作指南和图表模式。

核心原则

语气:叙事化、对话式、教学式。为 Project Profile 中的受众写作(参见 references/audience-adaptation.md);当没有画像时,默认为第一天上班的聪明同事。渐进式披露:先大局,后细节。对空白诚实——绝不捏造或推测。

内容规则:每个技术术语首次使用时都附有简短的行内解释。始终包含文件路径——每个论断都引用实际代码路径。图表内联——Mermaid 块嵌入文档中,而非单独文件。无 AI 套话:没有“在本文档中我们将……”,没有“让我们深入”,没有结尾总结。

图表标准:仅使用 Mermaid 语法。保持图表聚焦——每个图表最多 15-20 个节点。将复杂系统拆分为多个较小的图表。使用描述性节点标签,而非缩写。支持的类型:mindmap、flowchart、sequence、erDiagram、block-beta。

适用场景

适用于需要为陌生代码库快速生成人类可读项目指南的场景,特别是面向新加入团队的开发者或需要理解项目全貌的非技术人员。

限制

资料中未提供关于收费、价格、平台支持、具体效果或使用步骤的详细信息。