Shrimp Assistant
← 返回 Skill 仓库

codebase-onboarding

分析代码库，为新工程师、技术负责人和外包人员生成上手文档。快速收集事实，产出可复用的上手材料。适用于新工程师入职、为新项目编写架构概览文档，或为陌生仓库生成技术负责人简报。

slug: codebase-onboarding v1.0.0 工程开发 流程型 作者 Alireza Rezvani 5 个文件 · 13.4 KB 更新 2026-10-20 实测 +2.3% ↓ 0 次下载 💬 0 条反馈 规范度 94/100 by Alireza Rezvani
登录后下载（1 虾条） 使用反馈（0） 查看 JSON
实测评测 小幅提升 deepseek-chat · 2 任务 × 1 采样 × 3 重复 · 多轮协作 · 盲评 评测方法 →
+2.3%
带该 Skill vs 不带，
judge 盲评的平均分差。
n=3 次重复均值，区间 -2.3% ~ 4.6%
裸模型 73.3
带技能 75.7
评测时间 2026-10-20 2 个任务 × 1 次采样 盲评 · 同一模型同一组参数
展开 2 个测试任务的逐题明细
任务 1 · 客户临时要我们接手一个没写文档的 Node 服务做二次开发，我得先出一份技术负责人简报，说明架构和运维风险。
采样 1 裸 0.0 vs 带技能 0.0 两份最终交付质量接近，A 在首轮即给出可操作的信息索取清单、风险表述更克制且验证项更贴合材料，B 首轮偏框架化、部分结论推断略强。
任务 2 · 我们组下周要接手一个外包团队留下的 Python 数据管道仓库，没人熟悉它。请先给出你分析这个仓库所需的关键信息清单，我按清单提供。
采样 1 裸 88.0 vs 带技能 86.0 两份质量接近，A 在命令可执行性与不臆造方面更严谨，B 在风险编号与分工组织上更系统，整体 A 略优。
社区实测 用户用自己的 API Key 跑的结果，模型与环境各不相同，仅供横向参考 登录后用我的 API 测 →
还没有人跑过。装上你自己的 Key，用你日常用的模型测一遍——结果只出现在你的记录里，不进官方榜。
—
☆☆☆☆☆
还没有人评分，用过之后来说句实话
登录后评分

一行命令安装

下载这个 Skill 需要先登录（免费注册，只需用户名和密码）。去登录 →

使用反馈 · 0

用过的同学可以在这里说说效果、坑点或改进建议，也可以直接提出新需求。

登录后可以发表使用反馈。去登录 →

还没有反馈，来做第一个分享的人。

规范度体检 · 94/100

按元信息、示例、可执行性、完整性等 13 项自动检查，供作者自查改进；不影响用户评分。

版本历史

SKILL.md 内容

# Codebase Onboarding

**Tier:** POWERFUL  
**Category:** Engineering  
**Domain:** Documentation / Developer Experience

---

## Overview

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.

## Core Capabilities

- 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

---

## When to Use

- 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

---

## Quick Start

```bash
# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md
```

---

## Recommended Workflow

1. Run `scripts/codebase_analyzer.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

---

## Onboarding Document Template

Detailed template and section examples live in:
- `references/onboarding-template.md`
- `references/output-format-templates.md`

---

## Common Pitfalls

- Writing docs without validating setup commands on a clean environment
- Mixing architecture deep-dives into contractor-oriented docs
- Omitting troubleshooting and verification steps
- Letting onboarding docs drift from current repo state

## Best Practices

1. Keep setup instructions executable and time-bounded.
2. Document the "why" for key architectural decisions.
3. Update docs in the same PR as behavior changes.
4. Treat onboarding docs as living operational assets, not one-time deliverables.