alirezarezvani/claude-skills

codebase-onboarding

Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/alirezarezvani/claude-skills --skill codebase-onboarding

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

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.

Tâches connexes

du même dépôt

Autres Skills

Tous les Skills