Zc Codebase Onboarding

代码库导览

zmice 6a14623 1.5 KB Updated

File contents

代码库导览

这是 command:start 判型后进入的专项 skill:当任务核心是理解陌生项目、建立上下文地图、决定下一步从哪里切入时,进入这里。

何时使用

  • 第一次接触一个代码库
  • 要在陌生项目上开始实现、调试或重构
  • 需要快速建立项目全局认知
  • 需要生成后续任务可复用的项目概览

输入前提

  • 已确定要探索的仓库或子系统
  • 愿意先理解结构,再进入实现
  • 目标是产出概览,而不是理解一切细节

执行步骤

  1. 扫描目录结构和关键配置文件
  2. 定位入口点、路由、模型和主流程
  3. 梳理依赖关系、核心模块和数据流
  4. 识别架构模式、测试策略和项目约定
  5. 输出一份后续开发可复用的项目概览

成功标准

  • 能清楚说明项目类型、技术栈、入口点和关键目录
  • 核心模块职责和数据流向是明确的
  • 已记录当前任务相关的关键约定和陷阱
  • 输出足够短,能被后续任务直接消费

相关原则

  • 先读 README 和测试,再深挖源码
  • 聚焦当前任务相关区域,不求一次理解全仓库
  • 概览是压缩上下文,不是转述源码

回到主流程

  • 项目地图已经足够,可交给 context-engineering 做最小上下文装载
  • 如果接下来要定义需求或方案:回到 spec-driven-development
  • 如果已经确认目标,只是缺实现上下文:回到 incremental-implementation

zmice/zc-qwen-extension/tree/main/skills/zc-codebase-onboarding commit 6a14623bcd

Frequently asked questions

npx skillmds@latest add zmice/zc-codebase-onboarding