代码库分层文档生成
扫描代码库目录与关键文件,逐层生成带有父级上下文索引的 AGENTS.md 规范文档,提升 AI 协作理解力。
功能与用途
该功能专为提升 AI 代码辅助效果而设计。它会自动递归扫描并分析整个项目的目录结构与文件职责,按照层级自顶向下为每个目录生成标准化的 AGENTS.md 规范文档。文档内容涵盖目录职责、核心文件清单、子模块关系、AI 编码规范及测试要求,并建立父子索引链条。如果项目已存在文档,它会在保留人工手写备注的前提下增量更新,帮助 AI 助手在进入深层目录时快速掌握上下文。
适用场景
- 新项目 AI 上下文初始化:为新接手或新搭建的大型工程一键构建全量 AGENTS.md 体系,使 AI 编程工具快速理清工程脉络。
- 复杂目录工程规范沉淀:在前端组件库或后端微服务中拆解多层级结构,向 AI 明确各模块的编码惯例、测试规范与依赖关系。
- 代码重构后的文档增量同步:在目录结构或关键文件发生变更后重新扫描,自动刷新变动模块并完整保留开发者手写的定制备注。
适用人群
- 全栈开发者
- 开源项目维护者
- AI 辅助编程重度用户
- 大型工程架构师
使用步骤
- 在项目根目录启动该功能,触发全量目录结构自动扫描
- 规划自顶向下的分层生成清单,自动排除 build 和 node_modules 等目录
- 逐层分析文件与依赖,写入对应目录的 AGENTS.md 并链接父级文档
- 核对生成结果与父子引用完整性,必要时在 Manual Notes 补充人工规范
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-09-28
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Deep codebase initialization with hierarchical AGENTS.md documentation
依赖与权限
- 读取用户主动提供的内容