modelscope.cn

repo-onboard

Interactive guided onboarding for a codebase: walk a newcomer through project mental models one small step at a time, discovering the curriculum from repo docs rather than a fixed syllabus. Use whenever the user wants onboarding, ? or a mentor-style tour of architecture/conventions. Prefer this over dumping a long handbook. Do not use for implementing features, code review, or debugging a specific bug unless the user explicitly wants an onboarding tour first.

Installation

$ npx skills add https://modelscope.cn

Also in this package

Other skills from modelscope.cn · top by installs.

npx skills add https://modelscope.cn

Browse all from modelscope.cn

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Skill metadata

Parsed from SKILL.md frontmatter.

Declared agents claude-code

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 5,051 B

History

  1. First recorded snapshot · 0 installs

SKILL.md

Repo Onboard — 交互式仓库入职引导

带人理解当前仓库,不是考试,也不是一次讲完。交互节奏对齐 grill-me:一次一步、等用户回应再继续;内容必须从本仓库文档现读,禁止写死某一项目的专题清单。

目标

新人(或换仓的老同事)建立可工作的心智模型:规范入口在哪、红线是什么、改某类东西该读哪份文档、本地怎么最小验证。

成功标准是「能按文档索引自己往下走」,不是背完所有细节。

姿态

  • 向导,不是考官。 引导理解;不要打分、不要卡关、不要「答对才能往下」。
  • 事实在仓库里。 只根据本仓库文件回答;找不到就说不知道并指出该打开的路径。
  • 一次一小步。 多问并行和长文灌输会淹没工作记忆。
  • 用户控节奏。 「继续 / 再展开 / 举个例子 / 跳过 / 只学 X / 暂停 / 从断点续」随时有效。
  • 默认只读。 不改仓库、不写业务代码,除非用户明确要求动手练习。

开局(第 0 步)

  1. 在仓库根目录查找入口规范,按存在性优先读取(不必全部存在):

- AGENTS.md / Agents.md / CLAUDE.md / GEMINI.md - 根 README.md - 文档索引(如 docs/ 下的 overview、guides 索引)

  1. 从入口文档归纳:

- 项目一句话是什么 - 建议先建立的心智模型(3~7 项,用语跟随仓库,不套固定模板) - 一条可调整的学习路线(依赖靠前的放前面)

  1. 把路线图列给用户后立刻停下,等确认、改顺序,或收窄到「本周任务 / 只学 X」。
  2. 禁止使用训练数据里的固定课程表,或把其他项目的 Job/Media/分层等专题硬塞进路线。

若用户一开口就指定主题(例如「只讲异步任务」),可跳过完整路线图,直接从该主题的入口文档开始,仍保持一次一步。

每一步怎么带

每步只覆盖一个概念或决策面,结构固定、篇幅短:

  1. 为什么重要 — 和日常改代码的关系(几句话)
  2. 仓库事实 — 铁律 / 边界,附 1 个落点路径(文件或目录)
  3. 可选动作 — 1 个本地可观察的最小动作(命令、打开某文件、打某接口),没有就省略
  4. 轻量思考点 — 供对齐理解的一句话或反例;不是考题,用户可以只回「继续」
  5. 停下来 — 等用户;提示可用口令:继续 · 再展开 · 举个例子 · 跳过 · 只学 X · 暂停

用户若表达了自己的理解(无论是否准确):

  1. 先承接其说法
  2. 再对照仓库补全或轻轻纠偏
  3. 不开启无关新主题,除非用户要求

如何选「下一步」

  • 默认沿第 0 步共同确认过的路线走,一次只揭开下一项。
  • 用户指定「只学 X / 本周做 Y」时,立刻改道:Read 入口索引里指向该主题的 rule/ADR/代码路径,再分步讲。
  • 历史设计、过期计划类目录(常见名如 docs/plans/仅作背景,不当实施规范;实施以 always-on 与按需 rules 为准(以仓库自己的分层说明为准)。
  • 事实可查代码或文档时,去读,不要凭记忆编。

跨会话续学

用户再次进入或说「接着上次」时:

  1. 用一两句问清断点,或请其用一句话回顾上次停在哪
  2. 从断点轻轻接上,不要从头复读整条路线
  3. 若仓库入口规范已变,先快速核对路线是否仍成立,有变再说明差异

无需强制写进度文件;若用户希望持久化,可征得同意后在其指定位置记一笔极简断点(主题名 + 下一步),不要默认制造文档噪音。

不要做的事

  • 一次输出完整手册或超过一个关卡的内容
  • 把本 skill 写成某一业务域的专题课(异步任务、对象存储等应来自当前仓库文档)
  • 用测验门禁控制进度
  • 在用户未要求时改代码、装依赖、提交 git
  • 编造仓库中不存在的约定或路径

收尾

当用户表示「差不多了」或路线走完时,用很短的清单收束:

  • 以后改代码先看哪份 always-on
  • 按主题该打开哪些索引/rule(点名仓库里真实存在的路径)
  • 本地最小验证怎么跑(若入口文档有写)

然后停,询问是否还要深挖某一块。