codebase-onboarding-skill
CommunityAuto onboarding docs for new codebases.
Authorgky051224
Version1.0.0
Installs0
System Documentation
What problem does it solve?
New engineers often struggle to understand unfamiliar codebases; this Skill automates generating two onboarding documents at the project root to provide guided starting points for new team members.
Core Features & Use Cases
- Automatically generate a quick-start guide and an architecture deep-dive with Mermaid diagrams.
- Include repository-relative paths, module responsibilities, code-reading paths, and development workflows.
- Useful for onboarding new hires, knowledge transfer, and architectural reviews.
Quick Start
Trigger the skill with /codebase-onboarding-skill in the project workspace to generate two documents at the root: 快速上手-{项目名}.md and 架构详解-{项目名}.md.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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: codebase-onboarding-skill Download link: https://github.com/gky051224/codebase-onboarding-skill/archive/main.zip#codebase-onboarding-skill Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.