代码项目接手与入门文档

原名：codebase-onboarding

从获准仓库梳理结构、关键入口和常用操作，形成可复核的接手说明。

中文 Skills 技能说明

新数字员工接手老项目时，先看清结构再动代码。老板指定可读仓库、目标模块和敏感文件范围，技能用包内 Python 分析器收集技术栈、关键配置与入口，结合模板生成架构概览、运行步骤和贡献检查清单。扫描到文件不等于已经理解全部业务，未运行的命令和未确认的依赖应明确标注。仓库可能含密钥和客户资料，只读必要路径，不外传源码；安装、运行、写文件与提交代码须按授权进行，文档由项目负责人复核。

上游能力依据

上游原始适用说明：Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.

上游 SKILL.md 主要章节（保留原文标题）：

• Overview
• Core Capabilities
• When to Use
• Quick Start
• Recommended Workflow
• Onboarding Document Template
• Common Pitfalls
• Best Practices

使用边界

先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助，不补造客户反馈、经营数据、案例或引用。

作者、翻译与许可证

原作者

Alireza Rezvani 与 claude-skills contributors

中文翻译

CEOFans翻译

许可证

MIT

上游来源

https://github.com/alirezarezvani/claude-skills/tree/19392f7a08264ed00486a251f5b2098321771f94/engineering/skills/codebase-onboarding

适用范围

平台：linux、macos、windows；标签：研究与知识、代码项目接手与入门文档、开源技能

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件，请在最小权限环境中使用，高风险操作必须人工确认。

如发现侵权、许可证或安全问题，可在本页前台提交投诉，管理员复核后可立即下架。