Tools & Capabilities

onboarding-pack

ChenneyZhuang/onboarding-pack · ★ 0

ChenneyZhuang

Write the document a newcomer actually needs on day one: what this project is, how to run it, where things live, the five unwritten rules, and who to ask — discoverable, current…

README body is shown in Chinese.

License
MIT
Added
2026-10-30
Maintenance
active
Install kind
github
Manifest details
Manifest status
Declared
Manifest path
package.json#dsh
Manifest checked
2026-10-30T09:39:25.562Z
Lifecycle scripts
None found

Static manifest checks report declarations only; they are not compatibility or security review.

安装

dsh plugin --profile web add 'github:ChenneyZhuang/onboarding-pack#faf6ba92fea0e02d23c4a940d9165aa363bbb576'

GitHub 源码安装:首次需按提示配置 allowBuilds 构建授权后重试

For install and environment setup, plus plugin development tutorials, see DSH community docs ↗

README

Source README · body: zh · Read Chinese README

Table of contents
  1. Why / 为什么
  2. The five sections / 五节结构(10 分钟读完)
  3. Maintenance rule / 维护规则
  4. Honest limitations / 如实说明局限
  5. Install / 安装

Every project has two sets of knowledge: the written one, and the one in people's heads that takes a month of asking around. This skill writes the second one down.

每个项目都有两套知识:写下来的,和在人脑子里要问一个月的。这个 skill 把第二套写下来。

Why / 为什么

The expensive onboarding time is never spent on the README's install commands — it is spent discovering the unwritten rules: which file is actually authoritative, which script must never run in prod, why a weird choice was made, who decides what. An agent joining a project (or a human, or you in three months) pays the same tax. The onboarding pack is the tax prepaid, once.

昂贵的上手时间从来不是花在 README 的安装命令上——而是花在发现潜规则上:哪个文件才是权威、哪个脚本绝不能在生产跑、为什么有个怪选择、什么事谁拍板。agent 接手项目(或新人,或三个月后的你自己)交的是同一笔税。上手包就是一次预付。

The five sections / 五节结构(10 分钟读完)

  1. What & why — one paragraph: what this is, who it serves, what done looks like.
  2. Run it — the exact commands, in order, that produce a working setup.
  3. Map — where things live and which one is authoritative (every project has competing sources of truth; name the winner).
  4. Unwritten rules — the five or so things that are obvious to insiders and invisible to newcomers ("never edit X directly", "always check Y first", "Z is deprecated but still load-bearing").
  5. Who & where — owners, decision forums, and where questions go.

Maintenance rule / 维护规则

The pack is updated when the thing it describes changes — a new unwritten rule discovered while working, a file that moved, an owner who changed. Updating it is part of the change, the way tests are: a change that invalidates the pack and does not update it is an incomplete change.

包随其描述的对象变化而更新——工作中发现新的潜规则、文件搬家、负责人变更,更新是变更的一部分,就像测试一样:让包失效却不更新包的变更是不完整的变更。

Honest limitations / 如实说明局限

  • The pack goes stale without the update-as-part-of-change rule; a dated pack older than the last big change should be distrusted.
  • Unwritten rules are discovered by working — the first draft always misses some; the audit loop (newcomer questions → new entries) is how it converges.

不随变更更新就会过期;日期早于最近大变的包应被怀疑。潜规则靠工作中发现——初稿必然有遗漏;"新人提问→补条目"的循环才是收敛机制。

Install / 安装

npx skills add ChenneyZhuang/onboarding-pack

Per-agent paths: COMPATIBILITY.md. MIT. v0.1.0.

各 agent 安装路径见 COMPATIBILITY.md。MIT 许可,v0.1.0。