Heim

Skill

Dokumentation

codebase-onboarding

alirezarezvani/claude-skills

Analysieren Sie einen Code-Bestand und erstellen Sie Einarbeitungsunterlagen für Entwickler, technische Leiter und freiberufliche Mitarbeiter – mit schneller Informationsbeschaffung und standardisierten Ergebnissen.

...Alle erweitern

Zeit aktualisiert 30. August 2026

# documentation # onboarding # architecture discovery # codebase analysis # developer experience

Einführung in den Code

Stufe: POWERFUL
Kategorie: Technik
Bereich: Dokumentation / Entwicklererfahrung

Übersicht

Analysieren Sie eine Codebasis und erstellen Sie Einarbeitungsdokumentation für Ingenieure, technische Leiter und Auftragnehmer. Diese Funktion ist für die schnelle Erfassung von Fakten und wiederholbare Einarbeitungsergebnisse optimiert.

Kernfunktionen

Ermittlung der Architektur und des Tech-Stacks anhand von Repository-Signalen
Bestandsaufnahme wichtiger Dateien und Konfigurationen für neue Mitwirkende
Erstellung von Anleitungen für die lokale Einrichtung und häufige Aufgaben
Zielgruppenorientierte Gestaltung der Dokumentation
Erstellung von Gerüsten für Debugging- und Mitwirkungs-Checklisten

Anwendungsfälle

Einarbeitung eines neuen Teammitglieds oder Auftragnehmers
Neuerstellung veralteter Projektdokumente nach umfangreichen Refactorings
Erstellung interner Übergabedokumentation
Erstellung eines standardisierten Einarbeitungspakets für Dienstleistungen

Schnellstart

# 1) Daten zur Codebasis erfassen
python3 scripts/codebase_analyzer.py /Pfad/zum/Repo

# 2) Maschinell lesbare Ausgabe exportieren
python3 scripts/codebase_analyzer.py /Pfad/zum/Repo --json

# 3) Die Vorlage zum Erstellen von Onboarding-Dokumenten verwenden
# Siehe references/onboarding-template.md

Empfohlener Arbeitsablauf

Führen Sie „scripts/codebase_analyzer.py“ für das Ziel-Repository aus.
Erfassen Sie wichtige Kennzahlen: Anzahl der Dateien, erkannte Sprachen, Konfigurationsdateien, Struktur der obersten Ebene.
Füllen Sie die Onboarding-Vorlage in „references/onboarding-template.md“ aus.
Passen Sie die Detailtiefe der Ausgabe an die Zielgruppe an:
- Junior: Einrichtung + Leitplanken
- Senior: Architektur + betriebliche Aspekte
- Auftragnehmer: festgelegter Verantwortungsbereich + Integrationsgrenzen

Vorlage für Onboarding-Dokumente

Detaillierte Vorlage und Abschnittsbeispiele finden Sie unter:

references/onboarding-template.md
references/output-format-templates.md

Häufige Fallstricke

Dokumente verfassen, ohne die Einrichtungsbefehle in einer sauberen Umgebung zu überprüfen
Vermischung von tiefgehenden Einblicken in die Architektur mit dokumenten, die sich an Auftragnehmer richten
Das Auslassen von Schritten zur Fehlerbehebung und Überprüfung
Einlassen, dass Onboarding-Dokumentationen vom aktuellen Repo-Zustand abweichen

Bewährte Vorgehensweisen

Halten Sie Einrichtungsanweisungen umsetzbar und zeitlich begrenzt.
Dokumentieren Sie das „Warum“ hinter wichtigen architektonischen Entscheidungen.
Aktualisieren Sie die Dokumentation im selben Pull-Request wie die Verhaltensänderungen.
Behandeln Sie Onboarding-Dokumente als lebendige Betriebsressourcen und nicht als einmalige Lieferergebnisse.

Auf GitHub ansehen

---
name: codebase-onboarding
description: Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors, with fast fact-gathering and repeatable outputs.
---

# Codebase Onboarding

**Tier:** POWERFUL  
**Category:** Engineering  
**Domain:** Documentation / Developer Experience

---

## Overview

Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.

## Core Capabilities

- Architecture and stack discovery from repository signals
- Key file and config inventory for new contributors
- Local setup and common-task guidance generation
- Audience-aware documentation framing
- Debugging and contribution checklist scaffolding

---

## When to Use

- Onboarding a new team member or contractor
- Rebuilding stale project docs after large refactors
- Preparing internal handoff documentation
- Creating a standardized onboarding packet for services

---

## Quick Start

```bash
# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md
```

---

## Recommended Workflow

1. Run `scripts/codebase_analyzer.py` against the target repository.
2. Capture key signals: file counts, detected languages, config files, top-level structure.
3. Fill the onboarding template in `references/onboarding-template.md`.
4. Tailor output depth by audience:
   - Junior: setup + guardrails
   - Senior: architecture + operational concerns
   - Contractor: scoped ownership + integration boundaries

---

## Onboarding Document Template

Detailed template and section examples live in:
- `references/onboarding-template.md`
- `references/output-format-templates.md`

---

## Common Pitfalls

- Writing docs without validating setup commands on a clean environment
- Mixing architecture deep-dives into contractor-oriented docs
- Omitting troubleshooting and verification steps
- Letting onboarding docs drift from current repo state

## Best Practices

1. Keep setup instructions executable and time-bounded.
2. Document the "why" for key architectural decisions.
3. Update docs in the same PR as behavior changes.
4. Treat onboarding docs as living operational assets, not one-time deliverables.

Alle Dateien

0 Dateien

codebase-onboarding installieren

Laden Sie die Skill-Dateien herunter und entpacken Sie sie in Ihr Verzeichnis „.claude/skills/“.

ZIP herunterladen

Klonen Sie das Repository und kopieren Sie die Skill-Dateien in Ihr Projekt.

git clone https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding # Copy SKILL.md to your .claude/skills/ directory