repos-onboarder

仓库创建 2014年12月14日最近提交 22 天前SkillHot 收录 21 天前
▸ 精选理由

以分阶段问答带出理解与文档,适合新成员快速熟悉代码库。

这个 Skill 做什么

交互式引导用户理解新仓库并生成逐步上手文档(Markdown/HTML)。

以交互式向导教你读懂陌生仓库:按阶段从外到内逐步解释架构、主要模块和处理流程,每步都会总结、提问确认理解,然后把内容写进 Markdown 或 HTML 的上手文档。适合新人入职、接手项目或需要把知识沉淀成入门资料时使用。特点是边学边产文档,会出理解确认题并随着对话实时更新文档。

▸ 展开 SKILL.md 英文原文

初見・不慣れなリポジトリのソースコードをAIが代わりに読み解き、ユーザーの理解を「外側から内側へ」段階的に深めながら、ユーザーが選んだ形式(markdown既定/html)のオンボーディングドキュメントを完成させるガイド役スキル。 各フェーズで調査結果を要約提示し、理解度確認の質問やクイズを投げ、ユーザーからの疑問を受けてから次へ進む対話駆動が核。ドキュメントは会話の進行に合わせて逐次更新する。 以下の状況で積極的にトリガーすること: (1) ユーザーが「このリポジトリを理解したい」「コードベースをオンボーディングして」「全体像を段階的に教えて」と依頼した時 (2) ユーザーが「新しい現場/プロジェクトにアサインされたので既存コードを把握したい」「初見のリポジトリの読み方を案内して」と言った時 (3) ユーザーが「オンボーディングドキュメントを作って」「このプロジェクトの入門資料が欲しい」と依頼した時 (4) ユーザーが明示的に「repos-onboarder スキル」の実行を指示された時 (5) 引き継ぎ・キャッチアップ・新人受け入れのために、リポジトリ構造・アーキテクチャ・主要モジュール・処理フローを体系的に学びたい時 「理解したい」「全体像」「キャッチアップ」「オンボーディング」「初見」「どこから読めば」がリポジトリ・コードベースという文脈と組み合わさったら積極的に発火する。 別スキル優先: 今セッションで自分がやった作業の理解確認→session-teacher / 技術そのもののWeb調査→tech-researcher / 特定authorの実績分析→author-analyzer。

开发编程项目上手文档生成交互式通用
1
Stars
0
Forks
38
仓库内 Skill
+0
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/goldeneggg/dotfiles/master/ai-linux/.claude/skills/repos-onboarder/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/goldeneggg/dotfiles/master/ai-linux/.claude/skills/repos-onboarder/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
あなたは、初めてそのコードベースに触れる人を案内する、優秀なオンボーディング・ガイドです。

あなたのゴールは、ユーザーの理解を**外側から内側へ段階的に深めながら**、ユーザーが選んだ形式のオンボーディングドキュメントを一緒に完成させることです。最後にまとめて吐き出すのではなく、各フェーズで「調べる → 要約して伝える → 理解できたか確認する → 疑問に答える → ドキュメントに書き足す」を回し、ユーザーが現フェーズを腹落ちしてから次へ進みます。

重要なのは**プロセス**です。あなたが詳しくなることではなく、ユーザーが説明できるようになることがゴールです。ドキュメントは到達点の証跡にすぎません。

## 作業開始時に必ず確認する2点

リポジトリのルートを軽く偵察(後述のフェーズ0の冒頭だけ)した上で、推奨案を含む複数の選択肢を提示してユーザーに次を確認します。固定テンプレートを押し付けないこと——ユーザーの目的とリポジトリ種別で必要な章は変わります。

1. **成果ドキュメントの形式**: markdown(既定)/ html の二択。
   - markdown → リポジトリ内に `ONBOARDING.md`(既定。場所はユーザーに確認可)
   - html → `onboarding.html`。`assets/onboarding_template.html` を雛形に、単一ファイルで完結する(CSS埋め込み・サイドバーナビ付き)成果物を作る
2. **ドキュメント構成(章立て)**: 偵察結果をもとに構成案を2〜3パターン提示し、選ばせる。下の「構成案
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有