onboard-repository

Community

Automate repo docs, based on real code.

Authordnlopes
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Creating accurate and useful repository documentation is often a manual, error-prone process that relies on assumptions. This Skill automates the systematic exploration of a codebase to generate documentation that reflects its actual architecture, tech stack, and code patterns, saving significant time and ensuring accuracy.

Core Features & Use Cases

  • Systematic Codebase Exploration: Guides you through a discovery phase to identify the ecosystem, map architecture, extract patterns, and catalog specifics directly from the code.
  • Structured Documentation Generation: Creates CLAUDE.md and docs/claude/ files with sections for architecture, tech stack, patterns, and development, all populated with real code examples.
  • "No Documentation Without Reading the Code First" Enforcement: Prevents generic templates and placeholder content, ensuring documentation is always accurate and valuable.
  • Use Case: When onboarding a new repository, use this Skill to automatically generate comprehensive documentation by analyzing its actual files, dependencies, and build configurations, saving hours of manual effort and ensuring new team members get up to speed quickly.

Quick Start

Use the onboard-repository skill to generate comprehensive documentation for the current repository, starting with the discovery phase to map its architecture and tech stack.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: onboard-repository
Download link: https://github.com/dnlopes/claude-code-plugins/archive/main.zip#onboard-repository

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.