SKILL

codebase-onboarding

解释不熟悉的仓库,提供架构简报和入门文档。有人刚接触代码库,询问项目结构或从哪里开始阅读时使用。

译文已校对
查看英文原文

Explain an unfamiliar repo: architecture brief and onboarding docs. Use whenever someone is new to a codebase, asks how a project is structured or where to start reading.

适用对象:对象待分类。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。

查看英文原文

原文涵盖的主题

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

Tier: POWERFUL Category: Engineering Domain: Documentation / Developer Experience -- Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs. Architecture and stack discovery from repository signals Key file and config inventory for new contributors Local setup and common-task guidance generation Audience-aware documentation framing Debugging and contribution checklist scaffolding -- Onboarding a new team member or contractor Rebuilding stale project docs after large refactors Preparing internal handoff documentation Creating a standardized onboarding packet for services -- -- 1. Run scripts/codebaseanalyzer.py against the target repository. 2. Capture key signals: file counts, detected languages, config files, top-level structure. 3. Fill the onboarding template in references/onboarding-template.md. 4. Tailor output depth by audience: Junior: setup + guardrails Senior: architecture + operational concerns Contractor: scoped ownership + integration boundaries -- Detailed template and section examples live in: references/onboarding-template.md references/outp

这里只展示节选,请以完整原文和当前要求为准。

来源仓库
alirezarezvani/claude-skills
源文件
engineering/skills/codebase-onboarding/SKILL.md
固定版本
8f082544116fc0d014188e521ca40304cdfc86b0
阅读完整原作者说明 ↗

准备条件

  • 本条仅收录原作者的技能元数据;请阅读完整说明,确认依赖、许可与使用条件。

第一件可以尝试的小事

先阅读原作者说明,再决定是否在自己的 AI 工具中使用。

对应 AI 工具说明

作者有说明不等于本站实机验证。没有证据时,不自动标为兼容、安全或免费。

来源与内容状态

本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。

原作者:alirezarezvani/claude-skills · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-09T14:01:46.761Z。

分类由名称、说明与路径规则生成,分类不代表已核实适配。

许可与权利归属

MIT。第三方内容及版权归原作者,使用条件以原文为准。

许可原文 ↗

本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。

限制与注意事项

  • 元数据收录不代表本站已经安装、适配、实测或进行安全审查。