代码导航

3小时前更新 3 00

分层文档代码导航

收录时间:
2026-02-25
代码导航代码导航
代码导航

技能简介

代码导航(agentlens)是一款通过分层文档结构帮助理解和导航代码库的 Skill。使用 .agentlens/ 目录下的索引和模块文档,快速定位符号、查找 TODO、理解项目结构,无需直接阅读大量源代码。

业务背景

代码导航帮助开发团队快速上手陌生项目。通过分层文档结构,业务人员无需逐行阅读源码,即可掌握项目全局架构、模块职责及关键业务规则,显著降低新人熟悉成本,提升跨团队协作效率。

落地案例:某团队接手遗留系统时,使用代码导航查看 INDEX.md 了解整体架构,通过 memory.md 发现多处 TODO 和业务警告,避免修改时触发隐藏风险;借助 outline.md 在万行文件中快速定位核心函数,将需求评估时间从数天缩短至数小时。

能做什么

  • 通过 INDEX.md 获取项目全局视图和所有模块列表
  • 查看模块详情和文件清单(MODULE.md)
  • 在大型文件中定位函数和类(outline.md)
  • 查找 TODO、警告和业务规则(memory.md)
  • 理解文件依赖关系(imports.md)
  • 深入阅读复杂文件的详细文档

使用说明

安装 Skill:

通过 ClawHub 安装:

clawhub install agentlens

开始使用:

在处理任何代码库前,先阅读项目地图:

.agentlens/INDEX.md

导航层级:

  • L0 – INDEX.md:项目概览,所有模块列表
  • L1 – modules/{slug}/MODULE.md:模块详情、文件列表
  • L1 – modules/{slug}/outline.md:大型文件中的符号
  • L1 – modules/{slug}/memory.md:TODO、警告、业务规则
  • L1 – modules/{slug}/imports.md:文件依赖
  • L2 – files/{slug}.md:复杂文件的深度文档

导航流程:

INDEX.md → 找到模块 → MODULE.md → outline.md/memory.md → 源代码

何时阅读什么:

  • 项目概览:INDEX.md
  • 查找模块:INDEX.md,搜索模块名
  • 理解模块:modules/{slug}/MODULE.md
  • 大型文件找符号:modules/{slug}/outline.md
  • 找 TODO 和警告:modules/{slug}/memory.md
  • 理解依赖:modules/{slug}/imports.md

最佳实践:

  • 大型代码库不要直接读源文件,先使用 outline.md
  • 修改代码前检查 memory.md 查看警告和 TODO
  • 使用 outline.md 定位符号,然后只读需要的源码部分
  • 如文档过时,使用 agentlens 命令重新生成

输入与输出

项目内容
输入INDEX.md 路径、模块名、符号名、文件名
输出项目概览、模块详情、符号位置、TODO、依赖关系
适用人群理解大型代码库的开发者、新团队成员、代码审查人员
不包含自动生成文档、实时代码同步、代码编辑

 

见下方输入与输出表格。

风险提示

  • 文档可能过时,需要定期重新生成
  • 分层导航需要项目已配置 agentlens 文档结构
  • 大型项目依赖 outline.md 质量
  • 原始页信息不足:缺少文档生成命令的详细说明

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/nguyenphutrong/agentlens/SKILL.md

来源类型:GitHub

数据统计

相关导航

暂无评论

none
暂无评论...