codebase-onboarding
codebase-onboarding 是一个用于分析代码库并生成上手指南文档的 AI 技能,属于工程领域的文档与开发者体验方向。它面向工程师、技术负责人和外包合作者,强调快速收集事实、可重复产出。该技能可通过脚本分析目标仓库,输出文件数量、编程语言、配置文件及顶层目录结构等关键信号,并借助模板生成文档草稿。支持按受众调整深度:初级工程师侧重环境搭建与操作规范,资深工程师侧重架构与运维关注点,外包人员侧重职责范围与集成边界。核心能力包括架构与技术栈发现、关键文件与配置清单、本地搭建与常见任务指引、受众化文档框架以及调试与贡献清单脚手架。适用于新成员或外包入职、大规模重构后重写过时文档、内部交接文档准备,以及为多个服务创建标准化入职包等场景。使用时先运行分析脚本,可加 --json 输出机器可读结果,再参考模板文件填充内容。资料提示常见问题包括未在干净环境验证搭建命令、把架构深入内容混入外包文档、遗漏排查与验证步骤、文档与仓库现状脱节;最佳实践包括保持搭建指令可执行且有时限、记录关键架构决策的原因、行为变更时在同一 PR 更新文档,并把入职文档当作持续维护的运营资产而非一次性交付物。