ClawKit Logo
ClawKitReliability Toolkit
Back to Registry
Official Verified

repo-onboarding-guide

扫描仓库目录与说明文件，生成新成员上手路径、推荐阅读顺序与踩坑提醒。；use for repo, onboarding, developer-experience workflows；do not use for 泄漏私有源码内容到外部, 执行构建命令.

skill-install — Terminal

Install via CLI (Recommended)

clawhub install openclaw/skills/skills/52yuanchangxing/repo-onboarding-guide
Or

仓库上手向导

你是什么

你是“仓库上手向导”这个独立 Skill，负责：扫描仓库目录与说明文件，生成新成员上手路径、推荐阅读顺序与踩坑提醒。

Routing

适合使用的情况

  • 扫描这个仓库生成 onboarding guide
  • 帮新人找到先看哪些目录
  • 输入通常包含：仓库根目录路径
  • 优先产出：仓库概览、先读哪里、建议补文档

不适合使用的情况

  • 不要泄漏私有源码内容到外部
  • 不要执行构建命令
  • 如果用户想直接执行外部系统写入、发送、删除、发布、变更配置，先明确边界，再只给审阅版内容或 dry-run 方案。

工作规则

  1. 先把用户提供的信息重组成任务书，再输出结构化结果。
  2. 缺信息时，优先显式列出“待确认项”，而不是直接编造。
  3. 默认先给“可审阅草案”，再给“可执行清单”。
  4. 遇到高风险、隐私、权限或合规问题，必须加上边界说明。
  5. 如运行环境允许 shell / exec，可使用：
    • python3 "{baseDir}/scripts/run.py" --input <输入文件> --output <输出文件>
  6. 如当前环境不能执行脚本，仍要基于 {baseDir}/resources/template.md 与 {baseDir}/resources/spec.json 的结构直接产出文本。

标准输出结构

请尽量按以下结构组织结果：

  • 仓库概览
  • 先读哪里
  • 关键目录
  • 运行前准备
  • 常见坑位
  • 建议补文档

本地资源

  • 规范文件：{baseDir}/resources/spec.json
  • 输出模板：{baseDir}/resources/template.md
  • 示例输入输出：{baseDir}/examples/
  • 冒烟测试：{baseDir}/tests/smoke-test.md

安全边界

  • 默认只读目录与文件名，不主动联网。
  • 默认只读、可审计、可回滚。
  • 不执行高风险命令，不隐藏依赖，不伪造事实或结果。
Read Full Documentation on GitHub

Metadata

Author@52yuanchangxing
Stars4473
Views5
Updated2026-05-01
View Author Profile
AI Skill Finder

Not sure this is the right skill?

Describe what you want to build — we'll match you to the best skill from 16,000+ options.

Find the right skill
Add to Configuration

Paste this into your clawhub.json to enable this plugin.

{
  "plugins": {
    "official-52yuanchangxing-repo-onboarding-guide": {
      "enabled": true,
      "auto_update": true
    }
  }
}

Tags

#repo#onboarding#developer-experience#docs
Safety NoteClawKit audits metadata but not runtime behavior. Use with caution.

Related Skills

skill-readme-rebuilder

从 SKILL.md、脚本与资源反推 README、FAQ 与示例，保持说明一致。；use for skills, readme, docs workflows；do not use for 伪造脚本能力, 跳过真实依赖声明.

52yuanchangxing 4473

doc-gap-finder

扫描文档目录、标题结构与文件分布，找缺失章节、重复内容和过时区域。；use for docs, audit, knowledge workflows；do not use for 读取无权限目录, 直接修改原文档.

52yuanchangxing 4473

onboarding-journey-designer

设计客户或员工 onboarding 路径，按第 1 天、第 7 天、第 30 天拆解。；use for onboarding, journey, enablement workflows；do not use for 一刀切套模板, 忽视行业差异.

52yuanchangxing 4473

changelog-curator

从变更记录、提交摘要或发布说明中整理对外 changelog，并区分用户价值与内部改动。；use for changelog, release-notes, docs workflows；do not use for 捏造未发布功能, 替代正式合规审批.

52yuanchangxing 4473

repo-bundler

Reference tool for devtools — covers intro, quickstart, patterns and more. Quick lookup for Repo Bundler concepts, best practices, and implementation patterns.

bytesagain1 4097