← 一覧へ
🔍 コードを理解するCC / Codex 両対応難易度: 初心者

プロジェクトオンボーディングガイド生成 understand-onboard

プロジェクトに入る時の頼もしい相棒

出典リポの★
69,374
最終更新
1ヶ月前
作者
Egonex-AI

これは何?

これは、新しいメンバーがプロジェクトに参加する際に、スムーズに理解できるようにするための手助けツールです。プロジェクトの全体像や重要なファイル、設計上のポイントをまとめたガイドを自動生成します。

プロジェクトオンボーディングガイド生成の紹介マンガ

これでできること

  • プロジェクトの概要を簡単に把握できる
  • 各レイヤーの構造と主要なファイルを理解できる
  • 重要な設計上のポイントを確認できる
  • ガイドツアーを通じてステップバイステップで学べる
  • 複雑な部分を事前に認識できる

こんな時に便利

新メンバーがプロジェクトに参加するとき
プロジェクトのドキュメントが不足しているとき
複雑なプロジェクトの理解を助けたいとき
オンボーディングプロセスを標準化したいとき

使い方

まず、`.understand-anything/knowledge-graph.json`ファイルがあるか確認します。あれば、その中のデータを使ってオンボーディングガイドを生成します。生成されたガイドは、プロジェクトのドキュメントとして保存できます。

使用例(こう頼んでみよう)

このプロジェクトのオンボーディングガイドを生成して新メンバー向けのガイドを作成し、ドキュメントとして保存してプロジェクトの概要と主要ファイルの説明をまとめて

必要なもの

  • 特になし

導入方法

いちばん簡単(AIに頼む)
次のスキルを入れて: https://github.com/Egonex-AI/Understand-Anything/tree/main/understand-anything-plugin/skills/understand-onboard
手動で置く
Claude Code → ~/.claude/skills/understand-onboard/
Codex → ~/.agents/skills/understand-onboard/

使いこなしのコツ

  • 知識グラフがなければ、まず`/understand`を実行して生成しましょう。
  • ガイドをプロジェクトのドキュメントとして保存し、共有することをお勧めします。