PromptShop

Codebase Onboarding

This skill analyzes a codebase and generates onboarding documentation for engineers, tech leads, and contractors. It focuses on fast fact-gathering and...

Install

npx promptshop add codebase-onboarding

Details

What This Skill Does

This skill analyzes a codebase and generates onboarding documentation for engineers, tech leads, and contractors. It focuses on fast fact-gathering and repeatable onboarding outputs, providing key file inventories, local setup guidance, and debugging checklists. It's helpful for engineering teams looking to streamline the onboarding process.

When to Use

  • Onboard new team members.
  • Rebuild stale project documentation.
  • Prepare internal handoff documentation.
  • Create standardized onboarding packets.
  • Analyze codebase facts.
  • Draft onboarding docs from a template.

Key Features

  • Discovers architecture and stack from repository signals.
  • Provides key file and config inventory.
  • Generates local setup and common-task guidance.
  • Offers audience-aware documentation framing.
  • Scaffolds debugging and contribution checklists.
  • Provides an onboarding document template.