Codebase Onboarding

by affaan-mef648e01899bNo license275K starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 3 days ago

不慣れなコードベースを分析し、アーキテクチャマップ、主要なエントリポイント、規約、スターターCLAUDE.mdを含む構造化オンボーディングガイドを生成します。新しいプロジェクトに参加するか、リポでClaude Codeを初めてセットアップする場合に使用します。

AI-generated overview

Analyzes an unfamiliar codebase and produces a structured onboarding guide with architecture map, entry points, conventions, and a starter CLAUDE.md.

What it does
This skill walks an agent through a phased analysis of an unfamiliar repository: reconnaissance of package manifests, framework fingerprints, entry points, directory structure, configs, and test layout; then an architecture map of key modules and their relationships; then a review of code conventions and naming patterns. It produces a structured onboarding guide containing an architecture map, main entry points and flows, a conventions and style guide, and a starter CLAUDE.md file. It is instructions only and ships no scripts.
When to use it
Use it when opening a project in Claude Code for the first time, joining a new team or repository, or when someone asks for help understanding a codebase, wants a CLAUDE.md generated, or asks to be onboarded to or have a repository explained.
Requirements
No scripts or special tooling are required beyond the agent; it relies on reading files in the target repository.

コードベースオンボーディング

体系的に不慣れなコードベースを分析し、構造化オンボーディングガイドを作成。新しいプロジェクトに参加するか、既存リポでClaude Codeを初めてセットアップする開発者向けに設計。

使用時期

  • Claude Codeでプロジェクトを初めて開く
  • 新しいチームまたはリポに参加
  • ユーザーが「このコードベースを理解する手助けをしてください」と求める
  • ユーザーがプロジェクトのCLAUDE.mdを生成するよう要求
  • ユーザーが「オンボード」または「このリポを説明」と言う

動作方法

フェーズ1:偵察

すべてのファイルを読まずにプロジェクトについての生の信号を集めます。これらのチェックを並行して実行:

1. パッケージマニフェスト検出   → package.json, go.mod, Cargo.toml, pyproject.toml, pom.xml
2. フレームワークフィンガープリント   → next.config、nuxt.config、angular.json、vite.config
3. エントリポイント識別   → main.*、index.*、app.*、server.*
4. ディレクトリ構造スナップショット   → ディレクトリツリーの最上位2レベル
5. コンフィグとツール検出   → .eslintrc、.prettierrc、tsconfig.json、Dockerfile
6. テスト構造検出   → tests/、__tests__/、*.spec.ts、jest.config.*

フェーズ2:アーキテクチャマップ

主要なモジュールとそれらの関係を特定します。

フェーズ3:規約とスタイル

コード規約、命名パターン、プロジェクト固有のパターンを特定。

出力

  • アーキテクチャマップ
  • 主要なエントリポイントと流れ
  • 規約とスタイルガイド
  • スターターCLAUDE.md

Source and attribution

Source:affaan-m/eccindocs/ja-JP/skills/codebase-onboardingat commitef648e0

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal